9999: Generate Demo Dataset

Scenario #9999: Generate Demo Dataset

Create the mandant person Hostsharing eG

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG"
}
EOF
=> status: 201 CREATED f1b6be2b-7ec8-4d8a-a690-90a846fd07d5

Creating accounts needs an acting global-admin USER subject, but that subject does not need to have an own account (and thus a person) itself. Here, such a subject gets created: it is synchronized from Keycloak, and the global ADMIN role is granted to it, but no account is created for it.

Properties

Given

name	value
subjectUuid	de300000-0000-0000-0000-000000000001
subjectName	hsh-demo_admin

Synchronize the new USER Subject from Keycloak

HTTP PUT "/api/rbac/subjects/de300000-0000-0000-0000-000000000001" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "name" : "hsh-demo_admin",
  "type" : "USER"
}
EOF
=> status: 201 CREATED de300000-0000-0000-0000-000000000001

This is what the Keycloak sync program does for each new Keycloak user.

Prerequisite: Resolve the UUID of the global ADMIN role

The grant API needs the UUID of the role which we want to grant.

HTTP GET "/api/rbac/roles?name=rbac.global%23global%3AADMIN" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "8658b29c-8ecd-432c-9c32-99a44eb37e27",
  "object.uuid" : "767d456f-0fdd-4e21-bc7c-95dbbe556b65",
  "objectTable" : "rbac.global",
  "objectIdName" : "global",
  "roleType" : "ADMIN",
  "roleName" : "rbac.global#767d456f-0fdd-4e21-bc7c-95dbbe556b65:ADMIN",
  "roleIdName" : "rbac.global#global:ADMIN"
} ]

Grant the global ADMIN role to the new USER Subject

HTTP POST "/api/rbac/grants" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  -H 'Hostsharing-Assumed-Roles: rbac.global#global:ADMIN' \
  <<EOF
{
  "assumed" : true,
  "grantedRole.uuid" : "8658b29c-8ecd-432c-9c32-99a44eb37e27", // globalAdminRoleUuidToGrant
  "granteeSubject.uuid" : "de300000-0000-0000-0000-000000000001"
}
EOF
=> status: 201 CREATED 8658b29c-8ecd-432c-9c32-99a44eb37e27 // globalAdminRoleUuidToGrant

Verify the new global-admin Subject does not have an own Account

HTTP GET "/api/hs/accounts/current" \
  -H "Authorization: Bearer $HSADMINNG_JWT_BEARER" \
  `# {` \
  `#   "sub" : "uuid<hsh-demo_admin>"` \
  `# }`
=> status: 200 OK 
{
  "subject" : {
    "uuid" : "de300000-0000-0000-0000-000000000001",
    "name" : "hsh-demo_admin",
    "organization" : "hsh",
    "type" : "USER"
  },
  "person" : null,
  "globalAdmin" : true
}

UseCase Create Partner => Partner: P-90000 - Tannenhof Bürotechnik eG

Properties

Given

name	value
partnerNumber	P-90000
personType	LEGAL_PERSON
contactCaption	Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
postalAddress	“street”: “Am Anger 167”, “zipcode”: “86150”, “city”: “Augsburg”, “country”: “Germany”
officePhoneNumber	+49 171 3920080
emailAddress	info@tannenhof-buerotechnik-eg.example.org
tradeName	Tannenhof Bürotechnik eG
registrationOffice	Registergericht Augsburg
registrationNumber	555465

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5",
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Tannenhof Bürotechnik eG"
}
EOF
=> status: 201 CREATED 412aca70-cbe0-4a02-82b2-5343b612fced

Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
  "postalAddress" : {
    "street" : "Am Anger 167",
    "zipcode" : "86150",
    "city" : "Augsburg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920080"
  },
  "emailAddresses" : {
    "main" : "info@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 4f60be17-812c-4f2d-b037-f7c15be947b9

Create Partner: P-90000 - Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90000",
  "partnerRel" : {
    "anchor.uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "holder.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "contact.uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9" // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
  },
  "details" : {
    "registrationOffice" : "Registergericht Augsburg",
    "registrationNumber" : "555465"
  }
}
EOF
=> status: 201 CREATED 266f8564-c35b-4de7-8f74-6a96e5ff1216

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Tannenhof+B%C3%BCrotechnik+eG+-+Hauptkontakt+%28P-90000%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
  "anchor" : {
    "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
    "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
    "postalAddress" : {
      "zipcode" : "86150",
      "country" : "Germany",
      "city" : "Augsburg",
      "street" : "Am Anger 167"
    },
    "emailAddresses" : {
      "main" : "info@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920080"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Torsten Schneider - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - Vertretung (P-90000)
postalAddress	“name”: “Geschäftsführung”, “street”: “Wiesengrund 246”, “zipcode”: “50667”, “city”: “Köln”, “country”: “Germany”
phoneNumber	+49 221 4710870
emailAddress	torsten-schneider@tannenhof-buerotechnik-eg.example.org

Person: Torsten Schneider

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schneider",
  "givenName" : "Torsten"
}
EOF
=> status: 201 CREATED 984d2d47-a30f-4870-a12a-c2faa92d6acc

Contact: Torsten Schneider - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Torsten Schneider - Vertretung (P-90000)",
  "postalAddress" : {
    "name" : "Geschäftsführung",
    "street" : "Wiesengrund 246",
    "zipcode" : "50667",
    "city" : "Köln",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 221 4710870"
  },
  "emailAddresses" : {
    "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 54edd54b-5507-4fd1-9f6e-3b0417a9355a

Create REPRESENTATIVE: Torsten Schneider - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "984d2d47-a30f-4870-a12a-c2faa92d6acc", // Person: Torsten Schneider
  "contact.uuid" : "54edd54b-5507-4fd1-9f6e-3b0417a9355a" // Contact: Torsten Schneider - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 216c4851-d6de-4456-88f8-6457f79e655a

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/216c4851-d6de-4456-88f8-6457f79e655a" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "216c4851-d6de-4456-88f8-6457f79e655a",
  "anchor" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "984d2d47-a30f-4870-a12a-c2faa92d6acc", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "54edd54b-5507-4fd1-9f6e-3b0417a9355a", // Contact: Torsten Schneider - Vertretung (P-90000)
    "caption" : "Torsten Schneider - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Wiesengrund 246",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710870"
    }
  }
}

UseCase Add Demo Relation => REPRESENTATIVE: Susanne Weber - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - Vertretung (P-90000)
postalAddress	“street”: “Ulmenstraße 729”, “zipcode”: “44135”, “city”: “Dortmund”, “country”: “Germany”
phoneNumber	+49 171 3920066
emailAddress	susanne-weber@tannenhof-buerotechnik-eg.example.org

Person: Susanne Weber

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Weber",
  "givenName" : "Susanne"
}
EOF
=> status: 201 CREATED 50ff3802-ada0-4f2c-8606-c2893ed2b001

Contact: Susanne Weber - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Susanne Weber - Vertretung (P-90000)",
  "postalAddress" : {
    "street" : "Ulmenstraße 729",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920066"
  },
  "emailAddresses" : {
    "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED a5dc4ead-5c71-42c2-be62-936cbfe252ce

Create REPRESENTATIVE: Susanne Weber - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "50ff3802-ada0-4f2c-8606-c2893ed2b001", // Person: Susanne Weber
  "contact.uuid" : "a5dc4ead-5c71-42c2-be62-936cbfe252ce" // Contact: Susanne Weber - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 8716d650-7f74-467d-a878-dd22bf012913

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/8716d650-7f74-467d-a878-dd22bf012913" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "8716d650-7f74-467d-a878-dd22bf012913",
  "anchor" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "50ff3802-ada0-4f2c-8606-c2893ed2b001", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "a5dc4ead-5c71-42c2-be62-936cbfe252ce", // Contact: Susanne Weber - Vertretung (P-90000)
    "caption" : "Susanne Weber - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Ulmenstraße 729"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920066"
    }
  }
}

UseCase Add Demo Relation => REPRESENTATIVE: Claudia Großbaum - Vertretung (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
relationType	REPRESENTATIVE
holderGivenName	Claudia
holderFamilyName	Großbaum
contactCaption	Claudia Großbaum - Vertretung (P-90000)
postalAddress	“street”: “Am Anger 731”, “zipcode”: “20095”, “city”: “Hamburg”, “country”: “Germany”
phoneNumber	+49 40 66969668
emailAddress	claudia-grossbaum@tannenhof-buerotechnik-eg.example.org

Person: Claudia Großbaum

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Großbaum",
  "givenName" : "Claudia"
}
EOF
=> status: 201 CREATED c0fca63b-2af9-4383-a3f4-40ad4a71ba2b

Contact: Claudia Großbaum - Vertretung (P-90000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Claudia Großbaum - Vertretung (P-90000)",
  "postalAddress" : {
    "street" : "Am Anger 731",
    "zipcode" : "20095",
    "city" : "Hamburg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 40 66969668"
  },
  "emailAddresses" : {
    "main" : "claudia-grossbaum@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED f7a5e300-2571-404a-a529-e148fc7b7996

Create REPRESENTATIVE: Claudia Großbaum - Vertretung (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "c0fca63b-2af9-4383-a3f4-40ad4a71ba2b", // Person: Claudia Großbaum
  "contact.uuid" : "f7a5e300-2571-404a-a529-e148fc7b7996" // Contact: Claudia Großbaum - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 5bbc61de-4115-4b16-bbfb-3ce928de4449

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/5bbc61de-4115-4b16-bbfb-3ce928de4449" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "5bbc61de-4115-4b16-bbfb-3ce928de4449",
  "anchor" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "c0fca63b-2af9-4383-a3f4-40ad4a71ba2b", // Person: Claudia Großbaum
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Claudia",
    "familyName" : "Großbaum"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "f7a5e300-2571-404a-a529-e148fc7b7996", // Contact: Claudia Großbaum - Vertretung (P-90000)
    "caption" : "Claudia Großbaum - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "20095",
      "country" : "Germany",
      "city" : "Hamburg",
      "street" : "Am Anger 731"
    },
    "emailAddresses" : {
      "main" : "claudia-grossbaum@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 40 66969668"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aaa
bankAccountHolder	Tannenhof Bürotechnik eG (P-90000/0)
iban	DE15990200000838881174
bic	DEMVDEH0
billingContactCaption	Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
billingContactEmailAddress	rechnung0@tannenhof-buerotechnik-eg.example.org

BankAccount: Tannenhof Bürotechnik eG (P-90000/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
  "iban" : "DE15990200000838881174",
  "bic" : "DEMVDEH0"
}
EOF
=> status: 201 CREATED 4bdd8bf2-af55-4cf9-9015-5dbc7b0791b7

Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
  "emailAddresses" : {
    "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
  }
}
EOF
=> status: 201 CREATED 19a42e76-4183-4dfa-b7bd-a1f1b1adeac4

Create Debitor: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "holder.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "contact.uuid" : "19a42e76-4183-4dfa-b7bd-a1f1b1adeac4" // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "4bdd8bf2-af55-4cf9-9015-5dbc7b0791b7", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
  "defaultPrefix" : "aaa"
}
EOF
=> status: 201 CREATED f9e7fd52-2978-4af7-ae7e-3ca06820830f

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/f9e7fd52-2978-4af7-ae7e-3ca06820830f" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "f9e7fd52-2978-4af7-ae7e-3ca06820830f",
  "debitorRel" : {
    "uuid" : "46f9d402-55b8-4009-8271-b4ff706c76e6",
    "anchor" : {
      "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "19a42e76-4183-4dfa-b7bd-a1f1b1adeac4", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
      "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000000",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216",
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "ff161315-98cd-4830-bdd8-693903263880",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "4bdd8bf2-af55-4cf9-9015-5dbc7b0791b7", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
    "iban" : "DE15990200000838881174",
    "bic" : "DEMVDEH0"
  },
  "defaultPrefix" : "aaa"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000000-aktuell

Properties

Given

name	value
debitorNumber	D-9000000
mandateReference	D-9000000-aktuell
bankAccountHolder	Tannenhof Bürotechnik eG (P-90000/0/aktuell)
iban	DE86990200000766401011
bic	DEMVDEH0
agreement	2023-03-05
validFrom	2023-03-08

Debitor of D-9000000-aktuell

HTTP GET "/api/hs/office/debitors/D-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "f9e7fd52-2978-4af7-ae7e-3ca06820830f",
  "debitorRel" : {
    "uuid" : "46f9d402-55b8-4009-8271-b4ff706c76e6",
    "anchor" : {
      "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "19a42e76-4183-4dfa-b7bd-a1f1b1adeac4", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
      "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000000",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216",
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "ff161315-98cd-4830-bdd8-693903263880",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "4bdd8bf2-af55-4cf9-9015-5dbc7b0791b7", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
    "iban" : "DE15990200000838881174",
    "bic" : "DEMVDEH0"
  },
  "defaultPrefix" : "aaa"
}

BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Tannenhof Bürotechnik eG (P-90000/0/aktuell)",
  "iban" : "DE86990200000766401011",
  "bic" : "DEMVDEH0"
}
EOF
=> status: 201 CREATED 079e6c6f-6f9d-42d6-9c34-fb249377181e

Create SEPA-Mandat: D-9000000-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "f9e7fd52-2978-4af7-ae7e-3ca06820830f", // Debitor of D-9000000-aktuell
  "bankAccount.uuid" : "079e6c6f-6f9d-42d6-9c34-fb249377181e", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)
  "reference" : "D-9000000-aktuell",
  "agreement" : "2023-03-05",
  "validFrom" : "2023-03-08"
}
EOF
=> status: 201 CREATED fab3b745-aa08-460d-be61-b7fde2c6ea9e

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/fab3b745-aa08-460d-be61-b7fde2c6ea9e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "fab3b745-aa08-460d-be61-b7fde2c6ea9e",
  "debitor" : {
    "uuid" : "f9e7fd52-2978-4af7-ae7e-3ca06820830f", // Debitor of D-9000000-aktuell
    "debitorRel" : {
      "uuid" : "46f9d402-55b8-4009-8271-b4ff706c76e6",
      "anchor" : {
        "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "19a42e76-4183-4dfa-b7bd-a1f1b1adeac4", // Contact: Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)
        "caption" : "Tannenhof Bürotechnik eG - Rechnungsstelle (D-9000000)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000000",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216",
      "partnerNumber" : "P-90000",
      "partnerRel" : {
        "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
        "anchor" : {
          "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Tannenhof Bürotechnik eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
          "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
          "postalAddress" : {
            "zipcode" : "86150",
            "country" : "Germany",
            "city" : "Augsburg",
            "street" : "Am Anger 167"
          },
          "emailAddresses" : {
            "main" : "info@tannenhof-buerotechnik-eg.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920080"
          }
        }
      },
      "details" : {
        "uuid" : "ff161315-98cd-4830-bdd8-693903263880",
        "registrationOffice" : "Registergericht Augsburg",
        "registrationNumber" : "555465",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "4bdd8bf2-af55-4cf9-9015-5dbc7b0791b7", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0)
      "holder" : "Tannenhof Bürotechnik eG (P-90000/0)",
      "iban" : "DE15990200000838881174",
      "bic" : "DEMVDEH0"
    },
    "defaultPrefix" : "aaa"
  },
  "bankAccount" : {
    "uuid" : "079e6c6f-6f9d-42d6-9c34-fb249377181e", // BankAccount: Tannenhof Bürotechnik eG (P-90000/0/aktuell)
    "holder" : "Tannenhof Bürotechnik eG (P-90000/0/aktuell)",
    "iban" : "DE86990200000766401011",
    "bic" : "DEMVDEH0"
  },
  "reference" : "D-9000000-aktuell",
  "agreement" : "2023-03-05",
  "validFrom" : "2023-03-08",
  "validTo" : null
}

UseCase Create Membership => Membership: Tannenhof Bürotechnik eG

Properties

Given

name	value
partnerNumber	P-90000
validFrom	2011-05-13
membershipFeeBillable	true

Partner: P-90000

HTTP GET "/api/hs/office/partners/P-90000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216",
  "partnerNumber" : "P-90000",
  "partnerRel" : {
    "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
    "anchor" : {
      "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Tannenhof Bürotechnik eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
      "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
      "postalAddress" : {
        "zipcode" : "86150",
        "country" : "Germany",
        "city" : "Augsburg",
        "street" : "Am Anger 167"
      },
      "emailAddresses" : {
        "main" : "info@tannenhof-buerotechnik-eg.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 171 3920080"
      }
    }
  },
  "details" : {
    "uuid" : "ff161315-98cd-4830-bdd8-693903263880",
    "registrationOffice" : "Registergericht Augsburg",
    "registrationNumber" : "555465",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Tannenhof Bürotechnik eG

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216", // Partner: P-90000
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2011-05-13",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 1d02b16b-6fd4-4688-a529-8e2db1b29f04

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/1d02b16b-6fd4-4688-a529-8e2db1b29f04" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "1d02b16b-6fd4-4688-a529-8e2db1b29f04",
  "partner" : {
    "uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "ff161315-98cd-4830-bdd8-693903263880",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000000
reference	sign 2011-05-13
shareCount	37
comment	initial shares on joining
transactionDate	2011-05-13

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "1d02b16b-6fd4-4688-a529-8e2db1b29f04",
  "partner" : {
    "uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "ff161315-98cd-4830-bdd8-693903263880",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "1d02b16b-6fd4-4688-a529-8e2db1b29f04", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2011-05-13",
  "shareCount" : 37,
  "comment" : "initial shares on joining",
  "valueDate" : "2011-05-13"
}
EOF
=> status: 201 CREATED c6270956-4f9e-4bda-b2b2-4bf74b752517

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/c6270956-4f9e-4bda-b2b2-4bf74b752517" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "c6270956-4f9e-4bda-b2b2-4bf74b752517",
  "membership.uuid" : "1d02b16b-6fd4-4688-a529-8e2db1b29f04", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 37,
  "valueDate" : "2011-05-13",
  "reference" : "sign 2011-05-13",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000000
reference	sign 2011-05-13
assetValue	2368
comment	deposit for initial shares
transactionDate	2011-06-01

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "1d02b16b-6fd4-4688-a529-8e2db1b29f04", // membershipUuid
  "partner" : {
    "uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "ff161315-98cd-4830-bdd8-693903263880",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "1d02b16b-6fd4-4688-a529-8e2db1b29f04", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2011-05-13",
  "assetValue" : 2368,
  "comment" : "deposit for initial shares",
  "valueDate" : "2011-06-01"
}
EOF
=> status: 201 CREATED 7537a0e5-3484-4b69-af32-15cc171eea23

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/7537a0e5-3484-4b69-af32-15cc171eea23" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7537a0e5-3484-4b69-af32-15cc171eea23",
  "membership.uuid" : "1d02b16b-6fd4-4688-a529-8e2db1b29f04", // membershipUuid
  "membership.memberNumber" : "M-9000000",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2368,
  "valueDate" : "2011-06-01",
  "reference" : "sign 2011-05-13",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Susanne Weber (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	generalversammlung
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - Vertretung (P-90000)

Create SUBSCRIBER generalversammlung: Susanne Weber (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "50ff3802-ada0-4f2c-8606-c2893ed2b001", // Person: Susanne Weber
  "contact.uuid" : "a5dc4ead-5c71-42c2-be62-936cbfe252ce" // Contact: Susanne Weber - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED 70833ae4-04ce-41f7-8938-b01069d5a84c

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/70833ae4-04ce-41f7-8938-b01069d5a84c" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "70833ae4-04ce-41f7-8938-b01069d5a84c",
  "anchor" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "50ff3802-ada0-4f2c-8606-c2893ed2b001", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "a5dc4ead-5c71-42c2-be62-936cbfe252ce", // Contact: Susanne Weber - Vertretung (P-90000)
    "caption" : "Susanne Weber - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Ulmenstraße 729"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920066"
    }
  }
}

Contact: Torsten Schneider - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Birkenallee 253",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 89 99998954"
  },
  "emailAddresses" : {
    "main" : "torsten-schneider@example.net"
  }
}
EOF
=> status: 201 CREATED 00b76a3a-6f18-4165-aa6e-059f88a776d5

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	members-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "984d2d47-a30f-4870-a12a-c2faa92d6acc", // Person: Torsten Schneider
  "contact.uuid" : "00b76a3a-6f18-4165-aa6e-059f88a776d5" // Contact: Torsten Schneider - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 86a039b0-3b23-4cb5-8880-a7a055042aa7

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/86a039b0-3b23-4cb5-8880-a7a055042aa7" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "86a039b0-3b23-4cb5-8880-a7a055042aa7",
  "anchor" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "984d2d47-a30f-4870-a12a-c2faa92d6acc", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "00b76a3a-6f18-4165-aa6e-059f88a776d5", // Contact: Torsten Schneider - private Mailinglisten-Adresse
    "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Birkenallee 253"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998954"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	customers-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "984d2d47-a30f-4870-a12a-c2faa92d6acc", // Person: Torsten Schneider
  "contact.uuid" : "00b76a3a-6f18-4165-aa6e-059f88a776d5" // Contact: Torsten Schneider - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 8e1613ea-a1a6-4510-a8cf-120a8ed8c95a

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/8e1613ea-a1a6-4510-a8cf-120a8ed8c95a" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "8e1613ea-a1a6-4510-a8cf-120a8ed8c95a",
  "anchor" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "984d2d47-a30f-4870-a12a-c2faa92d6acc", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "00b76a3a-6f18-4165-aa6e-059f88a776d5", // Contact: Torsten Schneider - private Mailinglisten-Adresse
    "caption" : "Torsten Schneider - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Birkenallee 253"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998954"
    }
  }
}

Contact: Susanne Weber - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Susanne Weber - private Mailinglisten-Adresse",
  "postalAddress" : {
    "name" : "Geschäftsführung",
    "street" : "Schlehenweg 260",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 89 99998045"
  },
  "emailAddresses" : {
    "main" : "susanne-weber@example.net"
  }
}
EOF
=> status: 201 CREATED 81f171d4-0761-4669-b401-b8ebf1d7ea0c

UseCase Add Demo Subscription => SUBSCRIBER customers-discuss: Susanne Weber (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	customers-discuss
holderGivenName	Susanne
holderFamilyName	Weber
contactCaption	Susanne Weber - private Mailinglisten-Adresse

Create SUBSCRIBER customers-discuss: Susanne Weber (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-discuss",
  "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "50ff3802-ada0-4f2c-8606-c2893ed2b001", // Person: Susanne Weber
  "contact.uuid" : "81f171d4-0761-4669-b401-b8ebf1d7ea0c" // Contact: Susanne Weber - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 650e6bcf-802a-4f3f-9ce2-8fcc3f32873a

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/650e6bcf-802a-4f3f-9ce2-8fcc3f32873a" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "650e6bcf-802a-4f3f-9ce2-8fcc3f32873a",
  "anchor" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "50ff3802-ada0-4f2c-8606-c2893ed2b001", // Person: Susanne Weber
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Susanne",
    "familyName" : "Weber"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-discuss",
  "contact" : {
    "uuid" : "81f171d4-0761-4669-b401-b8ebf1d7ea0c", // Contact: Susanne Weber - private Mailinglisten-Adresse
    "caption" : "Susanne Weber - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Schlehenweg 260",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "susanne-weber@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 89 99998045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Torsten Schneider (P-90000)

Properties

Given

name	value
partnerPersonName	Tannenhof Bürotechnik eG
mailingList	operations-announce
holderGivenName	Torsten
holderFamilyName	Schneider
contactCaption	Torsten Schneider - Vertretung (P-90000)

Create SUBSCRIBER operations-announce: Torsten Schneider (P-90000)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
  "holder.uuid" : "984d2d47-a30f-4870-a12a-c2faa92d6acc", // Person: Torsten Schneider
  "contact.uuid" : "54edd54b-5507-4fd1-9f6e-3b0417a9355a" // Contact: Torsten Schneider - Vertretung (P-90000)
}
EOF
=> status: 201 CREATED a47c8c27-5b22-44ba-a238-a289d6b998f1

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/a47c8c27-5b22-44ba-a238-a289d6b998f1" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a47c8c27-5b22-44ba-a238-a289d6b998f1",
  "anchor" : {
    "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Tannenhof Bürotechnik eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "984d2d47-a30f-4870-a12a-c2faa92d6acc", // Person: Torsten Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Torsten",
    "familyName" : "Schneider"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "54edd54b-5507-4fd1-9f6e-3b0417a9355a", // Contact: Torsten Schneider - Vertretung (P-90000)
    "caption" : "Torsten Schneider - Vertretung (P-90000)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Wiesengrund 246",
      "name" : "Geschäftsführung"
    },
    "emailAddresses" : {
      "main" : "torsten-schneider@tannenhof-buerotechnik-eg.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710870"
    }
  }
}

UseCase Create Partner => Partner: P-90001 - Christian Krause

Properties

Given

name	value
partnerNumber	P-90001
personType	NATURAL_PERSON
contactCaption	Christian Krause - Hauptkontakt (P-90001)
postalAddress	“name”: “Buchhaltung”, “street”: “Kirschblütenweg 603”, “zipcode”: “90402”, “city”: “Nürnberg”, “country”: “Germany”
officePhoneNumber	+49 176 04069019
emailAddress	post@christian-krause.example.org
givenName	Christian
familyName	Krause
birthday	1954-05-11

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Christian Krause

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "givenName" : "Christian",
  "familyName" : "Krause"
}
EOF
=> status: 201 CREATED 5714c1f9-e185-4edd-bbd8-7dd42e015b6a

Contact: Christian Krause - Hauptkontakt (P-90001)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Krause - Hauptkontakt (P-90001)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Kirschblütenweg 603",
    "zipcode" : "90402",
    "city" : "Nürnberg",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069019"
  },
  "emailAddresses" : {
    "main" : "post@christian-krause.example.org"
  }
}
EOF
=> status: 201 CREATED 560f8e78-8530-4997-9332-5d9c61064cca

Create Partner: P-90001 - Christian Krause

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90001",
  "partnerRel" : {
    "anchor.uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "holder.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "contact.uuid" : "560f8e78-8530-4997-9332-5d9c61064cca" // Contact: Christian Krause - Hauptkontakt (P-90001)
  },
  "details" : {
    "birthday" : "1954-05-11"
  }
}
EOF
=> status: 201 CREATED bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Christian+Krause+-+Hauptkontakt+%28P-90001%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "be2ed027-f3fd-44cc-9fab-0a00d230badb",
  "anchor" : {
    "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
} ]

UseCase Create Demo Debitor => Debitor: Christian Krause - Rechnungsstelle (D-9000100)

Properties

Given

name	value
partnerPersonName	Christian Krause
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aab
bankAccountHolder	Christian Krause (P-90001/0)
iban	DE69990100000452472122
bic	DEMSDEH0
billingContactCaption	Christian Krause - Rechnungsstelle (D-9000100)
billingContactEmailAddress	rechnung0@christian-krause.example.org

BankAccount: Christian Krause (P-90001/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Christian Krause (P-90001/0)",
  "iban" : "DE69990100000452472122",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 19b90fc1-2aae-436c-b122-806d7c6b507d

Contact: Christian Krause - Rechnungsstelle (D-9000100)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
  "emailAddresses" : {
    "main" : "rechnung0@christian-krause.example.org"
  }
}
EOF
=> status: 201 CREATED aa32d052-c7fe-4067-a434-ab02b8d29cf7

Create Debitor: Christian Krause - Rechnungsstelle (D-9000100)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "holder.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "contact.uuid" : "aa32d052-c7fe-4067-a434-ab02b8d29cf7" // Contact: Christian Krause - Rechnungsstelle (D-9000100)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "19b90fc1-2aae-436c-b122-806d7c6b507d", // BankAccount: Christian Krause (P-90001/0)
  "defaultPrefix" : "aab"
}
EOF
=> status: 201 CREATED efa75aa4-0893-4a4b-8876-b6ad862ead66

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/efa75aa4-0893-4a4b-8876-b6ad862ead66" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "efa75aa4-0893-4a4b-8876-b6ad862ead66",
  "debitorRel" : {
    "uuid" : "9283250b-b2e1-472d-b935-47aec296e515",
    "anchor" : {
      "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "holder" : {
      "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "aa32d052-c7fe-4067-a434-ab02b8d29cf7", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
      "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@christian-krause.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000100",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3",
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "be2ed027-f3fd-44cc-9fab-0a00d230badb",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "0ffabc2d-4689-4bdb-ba0a-0cd4c18e133f",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "19b90fc1-2aae-436c-b122-806d7c6b507d", // BankAccount: Christian Krause (P-90001/0)
    "holder" : "Christian Krause (P-90001/0)",
    "iban" : "DE69990100000452472122",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aab"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000100-aktuell

Properties

Given

name	value
debitorNumber	D-9000100
mandateReference	D-9000100-aktuell
bankAccountHolder	Christian Krause (P-90001/0/aktuell)
iban	DE34990400000981678500
bic	DEMDDEB0
agreement	2023-07-17
validFrom	2023-07-21

Debitor of D-9000100-aktuell

HTTP GET "/api/hs/office/debitors/D-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "efa75aa4-0893-4a4b-8876-b6ad862ead66",
  "debitorRel" : {
    "uuid" : "9283250b-b2e1-472d-b935-47aec296e515",
    "anchor" : {
      "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "holder" : {
      "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "aa32d052-c7fe-4067-a434-ab02b8d29cf7", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
      "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@christian-krause.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000100",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3",
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "be2ed027-f3fd-44cc-9fab-0a00d230badb",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "0ffabc2d-4689-4bdb-ba0a-0cd4c18e133f",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "19b90fc1-2aae-436c-b122-806d7c6b507d", // BankAccount: Christian Krause (P-90001/0)
    "holder" : "Christian Krause (P-90001/0)",
    "iban" : "DE69990100000452472122",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aab"
}

BankAccount: Christian Krause (P-90001/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Christian Krause (P-90001/0/aktuell)",
  "iban" : "DE34990400000981678500",
  "bic" : "DEMDDEB0"
}
EOF
=> status: 201 CREATED 0dc4dcce-d91c-486b-b439-8125d991bc18

Create SEPA-Mandat: D-9000100-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "efa75aa4-0893-4a4b-8876-b6ad862ead66", // Debitor of D-9000100-aktuell
  "bankAccount.uuid" : "0dc4dcce-d91c-486b-b439-8125d991bc18", // BankAccount: Christian Krause (P-90001/0/aktuell)
  "reference" : "D-9000100-aktuell",
  "agreement" : "2023-07-17",
  "validFrom" : "2023-07-21"
}
EOF
=> status: 201 CREATED a024e441-4e1d-476a-bbcf-4bcecc964488

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/a024e441-4e1d-476a-bbcf-4bcecc964488" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a024e441-4e1d-476a-bbcf-4bcecc964488",
  "debitor" : {
    "uuid" : "efa75aa4-0893-4a4b-8876-b6ad862ead66", // Debitor of D-9000100-aktuell
    "debitorRel" : {
      "uuid" : "9283250b-b2e1-472d-b935-47aec296e515",
      "anchor" : {
        "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "holder" : {
        "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "aa32d052-c7fe-4067-a434-ab02b8d29cf7", // Contact: Christian Krause - Rechnungsstelle (D-9000100)
        "caption" : "Christian Krause - Rechnungsstelle (D-9000100)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@christian-krause.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000100",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3",
      "partnerNumber" : "P-90001",
      "partnerRel" : {
        "uuid" : "be2ed027-f3fd-44cc-9fab-0a00d230badb",
        "anchor" : {
          "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
          "personType" : "NATURAL_PERSON",
          "tradeName" : null,
          "salutation" : null,
          "title" : null,
          "givenName" : "Christian",
          "familyName" : "Krause"
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
          "caption" : "Christian Krause - Hauptkontakt (P-90001)",
          "postalAddress" : {
            "zipcode" : "90402",
            "country" : "Germany",
            "city" : "Nürnberg",
            "street" : "Kirschblütenweg 603",
            "name" : "Buchhaltung"
          },
          "emailAddresses" : {
            "main" : "post@christian-krause.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 176 04069019"
          }
        }
      },
      "details" : {
        "uuid" : "0ffabc2d-4689-4bdb-ba0a-0cd4c18e133f",
        "registrationOffice" : null,
        "registrationNumber" : null,
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : "1954-05-11",
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "19b90fc1-2aae-436c-b122-806d7c6b507d", // BankAccount: Christian Krause (P-90001/0)
      "holder" : "Christian Krause (P-90001/0)",
      "iban" : "DE69990100000452472122",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aab"
  },
  "bankAccount" : {
    "uuid" : "0dc4dcce-d91c-486b-b439-8125d991bc18", // BankAccount: Christian Krause (P-90001/0/aktuell)
    "holder" : "Christian Krause (P-90001/0/aktuell)",
    "iban" : "DE34990400000981678500",
    "bic" : "DEMDDEB0"
  },
  "reference" : "D-9000100-aktuell",
  "agreement" : "2023-07-17",
  "validFrom" : "2023-07-21",
  "validTo" : null
}

UseCase Create Membership => Membership: Christian Krause

Properties

Given

name	value
partnerNumber	P-90001
validFrom	2008-01-10
membershipFeeBillable	true

Partner: P-90001

HTTP GET "/api/hs/office/partners/P-90001" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3",
  "partnerNumber" : "P-90001",
  "partnerRel" : {
    "uuid" : "be2ed027-f3fd-44cc-9fab-0a00d230badb",
    "anchor" : {
      "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
      "personType" : "NATURAL_PERSON",
      "tradeName" : null,
      "salutation" : null,
      "title" : null,
      "givenName" : "Christian",
      "familyName" : "Krause"
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
      "caption" : "Christian Krause - Hauptkontakt (P-90001)",
      "postalAddress" : {
        "zipcode" : "90402",
        "country" : "Germany",
        "city" : "Nürnberg",
        "street" : "Kirschblütenweg 603",
        "name" : "Buchhaltung"
      },
      "emailAddresses" : {
        "main" : "post@christian-krause.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 176 04069019"
      }
    }
  },
  "details" : {
    "uuid" : "0ffabc2d-4689-4bdb-ba0a-0cd4c18e133f",
    "registrationOffice" : null,
    "registrationNumber" : null,
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : "1954-05-11",
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Christian Krause

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3", // Partner: P-90001
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2008-01-10",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 62d846d3-1b52-48a4-a49d-2bf3a4b91594

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/62d846d3-1b52-48a4-a49d-2bf3a4b91594" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "62d846d3-1b52-48a4-a49d-2bf3a4b91594",
  "partner" : {
    "uuid" : "bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "be2ed027-f3fd-44cc-9fab-0a00d230badb",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "0ffabc2d-4689-4bdb-ba0a-0cd4c18e133f",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000100
reference	sign 2008-01-10
shareCount	32
comment	initial shares on joining
transactionDate	2008-01-10

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "62d846d3-1b52-48a4-a49d-2bf3a4b91594",
  "partner" : {
    "uuid" : "bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "be2ed027-f3fd-44cc-9fab-0a00d230badb",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "0ffabc2d-4689-4bdb-ba0a-0cd4c18e133f",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "62d846d3-1b52-48a4-a49d-2bf3a4b91594", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2008-01-10",
  "shareCount" : 32,
  "comment" : "initial shares on joining",
  "valueDate" : "2008-01-10"
}
EOF
=> status: 201 CREATED 0e83b3eb-5ffd-4003-8f84-7ef556a7e9d4

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/0e83b3eb-5ffd-4003-8f84-7ef556a7e9d4" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "0e83b3eb-5ffd-4003-8f84-7ef556a7e9d4",
  "membership.uuid" : "62d846d3-1b52-48a4-a49d-2bf3a4b91594", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 32,
  "valueDate" : "2008-01-10",
  "reference" : "sign 2008-01-10",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000100
reference	sign 2008-01-10
assetValue	2048
comment	deposit for initial shares
transactionDate	2008-01-15

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000100" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "62d846d3-1b52-48a4-a49d-2bf3a4b91594", // membershipUuid
  "partner" : {
    "uuid" : "bf0703fd-9b9b-4a4e-a9b2-81e7856b61b3", // Partner: P-90001
    "partnerNumber" : "P-90001",
    "partnerRel" : {
      "uuid" : "be2ed027-f3fd-44cc-9fab-0a00d230badb",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
        "personType" : "NATURAL_PERSON",
        "tradeName" : null,
        "salutation" : null,
        "title" : null,
        "givenName" : "Christian",
        "familyName" : "Krause"
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
        "caption" : "Christian Krause - Hauptkontakt (P-90001)",
        "postalAddress" : {
          "zipcode" : "90402",
          "country" : "Germany",
          "city" : "Nürnberg",
          "street" : "Kirschblütenweg 603",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "post@christian-krause.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069019"
        }
      }
    },
    "details" : {
      "uuid" : "0ffabc2d-4689-4bdb-ba0a-0cd4c18e133f",
      "registrationOffice" : null,
      "registrationNumber" : null,
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : "1954-05-11",
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000100",
  "memberNumberSuffix" : "00",
  "validFrom" : "2008-01-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "62d846d3-1b52-48a4-a49d-2bf3a4b91594", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2008-01-10",
  "assetValue" : 2048,
  "comment" : "deposit for initial shares",
  "valueDate" : "2008-01-15"
}
EOF
=> status: 201 CREATED 383c978c-fb89-4118-ac04-3df6aef4a716

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/383c978c-fb89-4118-ac04-3df6aef4a716" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "383c978c-fb89-4118-ac04-3df6aef4a716",
  "membership.uuid" : "62d846d3-1b52-48a4-a49d-2bf3a4b91594", // membershipUuid
  "membership.memberNumber" : "M-9000100",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2048,
  "valueDate" : "2008-01-15",
  "reference" : "sign 2008-01-10",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	generalversammlung
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER generalversammlung: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
  "holder.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
  "contact.uuid" : "560f8e78-8530-4997-9332-5d9c61064cca" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED d54eb7fc-4381-439d-86d2-85d0ad676664

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/d54eb7fc-4381-439d-86d2-85d0ad676664" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d54eb7fc-4381-439d-86d2-85d0ad676664",
  "anchor" : {
    "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	customers-announce
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER customers-announce: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
  "holder.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
  "contact.uuid" : "560f8e78-8530-4997-9332-5d9c61064cca" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED 067e96a9-5a57-4102-a49e-3c935e926795

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/067e96a9-5a57-4102-a49e-3c935e926795" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "067e96a9-5a57-4102-a49e-3c935e926795",
  "anchor" : {
    "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Christian Krause (P-90001)

Properties

Given

name	value
partnerPersonName	Christian Krause
mailingList	operations-announce
holderGivenName	Christian
holderFamilyName	Krause
contactCaption	Christian Krause - Hauptkontakt (P-90001)

Create SUBSCRIBER operations-announce: Christian Krause (P-90001)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
  "holder.uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
  "contact.uuid" : "560f8e78-8530-4997-9332-5d9c61064cca" // Contact: Christian Krause - Hauptkontakt (P-90001)
}
EOF
=> status: 201 CREATED a22e9a5c-66a9-4e8c-9a12-8da5610a7a91

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/a22e9a5c-66a9-4e8c-9a12-8da5610a7a91" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a22e9a5c-66a9-4e8c-9a12-8da5610a7a91",
  "anchor" : {
    "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "holder" : {
    "uuid" : "5714c1f9-e185-4edd-bbd8-7dd42e015b6a", // Person: Christian Krause
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Krause"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "560f8e78-8530-4997-9332-5d9c61064cca", // Contact: Christian Krause - Hauptkontakt (P-90001)
    "caption" : "Christian Krause - Hauptkontakt (P-90001)",
    "postalAddress" : {
      "zipcode" : "90402",
      "country" : "Germany",
      "city" : "Nürnberg",
      "street" : "Kirschblütenweg 603",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "post@christian-krause.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069019"
    }
  }
}

UseCase Create Partner => Partner: P-90002 - Fischer Pflege GmbH

Properties

Given

name	value
partnerNumber	P-90002
personType	LEGAL_PERSON
contactCaption	Fischer Pflege GmbH - Hauptkontakt (P-90002)
postalAddress	“street”: “Bachstraße 553”, “zipcode”: “28195”, “city”: “Bremen”, “country”: “Germany”
officePhoneNumber	+49 171 3920003
emailAddress	info@fischer-pflege-gmbh.example.org
tradeName	Fischer Pflege GmbH
registrationOffice	Registergericht Bremen
registrationNumber	310659

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Fischer Pflege GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Fischer Pflege GmbH"
}
EOF
=> status: 201 CREATED 162598de-bdac-4cdc-a090-eb14f3bc24db

Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
  "postalAddress" : {
    "street" : "Bachstraße 553",
    "zipcode" : "28195",
    "city" : "Bremen",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920003"
  },
  "emailAddresses" : {
    "main" : "info@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 7de51c76-f671-4489-827a-32107a0c08ee

Create Partner: P-90002 - Fischer Pflege GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90002",
  "partnerRel" : {
    "anchor.uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "holder.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "contact.uuid" : "7de51c76-f671-4489-827a-32107a0c08ee" // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
  },
  "details" : {
    "registrationOffice" : "Registergericht Bremen",
    "registrationNumber" : "310659"
  }
}
EOF
=> status: 201 CREATED e916a0e2-81ad-4406-85cd-affca17666dd

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Fischer+Pflege+GmbH+-+Hauptkontakt+%28P-90002%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
  "anchor" : {
    "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
    "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
    "postalAddress" : {
      "zipcode" : "28195",
      "country" : "Germany",
      "city" : "Bremen",
      "street" : "Bachstraße 553"
    },
    "emailAddresses" : {
      "main" : "info@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920003"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Daniel Fischer - Vertretung (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	REPRESENTATIVE
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - Vertretung (P-90002)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Dorfstraße 882”, “zipcode”: “50667”, “city”: “Köln”, “country”: “Germany”
phoneNumber	+49 221 4710601
emailAddress	daniel-fischer@fischer-pflege-gmbh.example.org

Person: Daniel Fischer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fischer",
  "givenName" : "Daniel"
}
EOF
=> status: 201 CREATED 1f9ce160-a39c-4e6d-9bb4-93d1af543c3a

Contact: Daniel Fischer - Vertretung (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Daniel Fischer - Vertretung (P-90002)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Dorfstraße 882",
    "zipcode" : "50667",
    "city" : "Köln",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 221 4710601"
  },
  "emailAddresses" : {
    "main" : "daniel-fischer@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 870ffbaf-1df9-4733-8a06-b946725f5268

Create REPRESENTATIVE: Daniel Fischer - Vertretung (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
  "holder.uuid" : "1f9ce160-a39c-4e6d-9bb4-93d1af543c3a", // Person: Daniel Fischer
  "contact.uuid" : "870ffbaf-1df9-4733-8a06-b946725f5268" // Contact: Daniel Fischer - Vertretung (P-90002)
}
EOF
=> status: 201 CREATED 389ef345-8712-4b79-af26-12175f4dc13d

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/389ef345-8712-4b79-af26-12175f4dc13d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "389ef345-8712-4b79-af26-12175f4dc13d",
  "anchor" : {
    "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "1f9ce160-a39c-4e6d-9bb4-93d1af543c3a", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "870ffbaf-1df9-4733-8a06-b946725f5268", // Contact: Daniel Fischer - Vertretung (P-90002)
    "caption" : "Daniel Fischer - Vertretung (P-90002)",
    "postalAddress" : {
      "zipcode" : "50667",
      "country" : "Germany",
      "city" : "Köln",
      "street" : "Dorfstraße 882",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 221 4710601"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Detlef Keller - Technik (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	OPERATIONS
holderGivenName	Detlef
holderFamilyName	Keller
contactCaption	Detlef Keller - Technik (P-90002)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Goethestraße 288”, “zipcode”: “53111”, “city”: “Bonn”, “country”: “Germany”
phoneNumber	+49 171 3920098
emailAddress	detlef-keller@fischer-pflege-gmbh.example.org

Person: Detlef Keller

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Keller",
  "givenName" : "Detlef"
}
EOF
=> status: 201 CREATED 6b390766-ae10-489a-b924-0944b84d03a5

Contact: Detlef Keller - Technik (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Detlef Keller - Technik (P-90002)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Goethestraße 288",
    "zipcode" : "53111",
    "city" : "Bonn",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920098"
  },
  "emailAddresses" : {
    "main" : "detlef-keller@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 036ffc54-dd8c-403a-a138-f877483e97a6

Create OPERATIONS: Detlef Keller - Technik (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
  "holder.uuid" : "6b390766-ae10-489a-b924-0944b84d03a5", // Person: Detlef Keller
  "contact.uuid" : "036ffc54-dd8c-403a-a138-f877483e97a6" // Contact: Detlef Keller - Technik (P-90002)
}
EOF
=> status: 201 CREATED e59fd2a1-3786-4e45-89a5-adf078b0a7f6

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/e59fd2a1-3786-4e45-89a5-adf078b0a7f6" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e59fd2a1-3786-4e45-89a5-adf078b0a7f6",
  "anchor" : {
    "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "6b390766-ae10-489a-b924-0944b84d03a5", // Person: Detlef Keller
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Detlef",
    "familyName" : "Keller"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "036ffc54-dd8c-403a-a138-f877483e97a6", // Contact: Detlef Keller - Technik (P-90002)
    "caption" : "Detlef Keller - Technik (P-90002)",
    "postalAddress" : {
      "zipcode" : "53111",
      "country" : "Germany",
      "city" : "Bonn",
      "street" : "Goethestraße 288",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "detlef-keller@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920098"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Doris Schneider - Technik (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
relationType	OPERATIONS
holderGivenName	Doris
holderFamilyName	Schneider
contactCaption	Doris Schneider - Technik (P-90002)
postalAddress	“street”: “Nelkenweg 142”, “zipcode”: “80331”, “city”: “München”, “country”: “Germany”
phoneNumber	+49 89 99998458
emailAddress	doris-schneider@fischer-pflege-gmbh.example.org

Person: Doris Schneider

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schneider",
  "givenName" : "Doris"
}
EOF
=> status: 201 CREATED e2b63d17-f74b-49bf-99fa-6f2958def27f

Contact: Doris Schneider - Technik (P-90002)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Doris Schneider - Technik (P-90002)",
  "postalAddress" : {
    "street" : "Nelkenweg 142",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 89 99998458"
  },
  "emailAddresses" : {
    "main" : "doris-schneider@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 01c2ebb3-2985-4114-a872-553dc07e35ae

Create OPERATIONS: Doris Schneider - Technik (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
  "holder.uuid" : "e2b63d17-f74b-49bf-99fa-6f2958def27f", // Person: Doris Schneider
  "contact.uuid" : "01c2ebb3-2985-4114-a872-553dc07e35ae" // Contact: Doris Schneider - Technik (P-90002)
}
EOF
=> status: 201 CREATED b027d541-6d06-4b32-936d-c1bcfdd3e494

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/b027d541-6d06-4b32-936d-c1bcfdd3e494" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b027d541-6d06-4b32-936d-c1bcfdd3e494",
  "anchor" : {
    "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "e2b63d17-f74b-49bf-99fa-6f2958def27f", // Person: Doris Schneider
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Doris",
    "familyName" : "Schneider"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "01c2ebb3-2985-4114-a872-553dc07e35ae", // Contact: Doris Schneider - Technik (P-90002)
    "caption" : "Doris Schneider - Technik (P-90002)",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Nelkenweg 142"
    },
    "emailAddresses" : {
      "main" : "doris-schneider@fischer-pflege-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 89 99998458"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	false
defaultPrefix	aac
bankAccountHolder	Fischer Pflege GmbH (P-90002/0)
iban	DE35990100000247429672
bic	DEMSDEH0
billingContactCaption	Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
billingContactEmailAddress	rechnung0@fischer-pflege-gmbh.example.org

BankAccount: Fischer Pflege GmbH (P-90002/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/0)",
  "iban" : "DE35990100000247429672",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 9b9849d6-fcdc-450f-8795-4ac5078a944c

Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
  "emailAddresses" : {
    "main" : "rechnung0@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 81999970-65f9-408d-b7eb-bf88de12e71e

Create Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "holder.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "contact.uuid" : "81999970-65f9-408d-b7eb-bf88de12e71e" // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "9b9849d6-fcdc-450f-8795-4ac5078a944c", // BankAccount: Fischer Pflege GmbH (P-90002/0)
  "defaultPrefix" : "aac"
}
EOF
=> status: 201 CREATED 3bc89548-c7b7-4b06-af0e-9fef89251471

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/3bc89548-c7b7-4b06-af0e-9fef89251471" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "3bc89548-c7b7-4b06-af0e-9fef89251471",
  "debitorRel" : {
    "uuid" : "de6b7a80-057a-4075-8796-d0f8bda98139",
    "anchor" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "81999970-65f9-408d-b7eb-bf88de12e71e", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000200",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "9b9849d6-fcdc-450f-8795-4ac5078a944c", // BankAccount: Fischer Pflege GmbH (P-90002/0)
    "holder" : "Fischer Pflege GmbH (P-90002/0)",
    "iban" : "DE35990100000247429672",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aac"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000200-aktuell

Properties

Given

name	value
debitorNumber	D-9000200
mandateReference	D-9000200-aktuell
bankAccountHolder	Fischer Pflege GmbH (P-90002/0/aktuell)
iban	DE76990100000045503743
bic	DEMSDEH0
agreement	2013-05-03
validFrom	2013-05-17

Debitor of D-9000200-aktuell

HTTP GET "/api/hs/office/debitors/D-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "3bc89548-c7b7-4b06-af0e-9fef89251471",
  "debitorRel" : {
    "uuid" : "de6b7a80-057a-4075-8796-d0f8bda98139",
    "anchor" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "81999970-65f9-408d-b7eb-bf88de12e71e", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000200",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : false,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "9b9849d6-fcdc-450f-8795-4ac5078a944c", // BankAccount: Fischer Pflege GmbH (P-90002/0)
    "holder" : "Fischer Pflege GmbH (P-90002/0)",
    "iban" : "DE35990100000247429672",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aac"
}

BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/0/aktuell)",
  "iban" : "DE76990100000045503743",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 3db69cb9-6244-4d64-bdca-0fbc3abe5262

Create SEPA-Mandat: D-9000200-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "3bc89548-c7b7-4b06-af0e-9fef89251471", // Debitor of D-9000200-aktuell
  "bankAccount.uuid" : "3db69cb9-6244-4d64-bdca-0fbc3abe5262", // BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)
  "reference" : "D-9000200-aktuell",
  "agreement" : "2013-05-03",
  "validFrom" : "2013-05-17"
}
EOF
=> status: 201 CREATED 784fe111-432b-40b6-bf74-be3186fe0ee7

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/784fe111-432b-40b6-bf74-be3186fe0ee7" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "784fe111-432b-40b6-bf74-be3186fe0ee7",
  "debitor" : {
    "uuid" : "3bc89548-c7b7-4b06-af0e-9fef89251471", // Debitor of D-9000200-aktuell
    "debitorRel" : {
      "uuid" : "de6b7a80-057a-4075-8796-d0f8bda98139",
      "anchor" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "81999970-65f9-408d-b7eb-bf88de12e71e", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000200)
        "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000200)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000200",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd",
      "partnerNumber" : "P-90002",
      "partnerRel" : {
        "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
        "anchor" : {
          "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Fischer Pflege GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
          "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
          "postalAddress" : {
            "zipcode" : "28195",
            "country" : "Germany",
            "city" : "Bremen",
            "street" : "Bachstraße 553"
          },
          "emailAddresses" : {
            "main" : "info@fischer-pflege-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920003"
          }
        }
      },
      "details" : {
        "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
        "registrationOffice" : "Registergericht Bremen",
        "registrationNumber" : "310659",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : false,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "9b9849d6-fcdc-450f-8795-4ac5078a944c", // BankAccount: Fischer Pflege GmbH (P-90002/0)
      "holder" : "Fischer Pflege GmbH (P-90002/0)",
      "iban" : "DE35990100000247429672",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aac"
  },
  "bankAccount" : {
    "uuid" : "3db69cb9-6244-4d64-bdca-0fbc3abe5262", // BankAccount: Fischer Pflege GmbH (P-90002/0/aktuell)
    "holder" : "Fischer Pflege GmbH (P-90002/0/aktuell)",
    "iban" : "DE76990100000045503743",
    "bic" : "DEMSDEH0"
  },
  "reference" : "D-9000200-aktuell",
  "agreement" : "2013-05-03",
  "validFrom" : "2013-05-17",
  "validTo" : null
}

UseCase Create Demo Debitor => Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
debitorNumberSuffix	01
billable	true
vatBusiness	true
defaultPrefix	aad
bankAccountHolder	Fischer Pflege GmbH (P-90002/1)
iban	DE44990100000597317337
bic	DEMSDEH0
billingContactCaption	Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
billingContactEmailAddress	rechnung1@fischer-pflege-gmbh.example.org

BankAccount: Fischer Pflege GmbH (P-90002/1)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/1)",
  "iban" : "DE44990100000597317337",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED a1ed4017-70a6-4b09-9cbf-433a80ca9d48

Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
  "emailAddresses" : {
    "main" : "rechnung1@fischer-pflege-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 012d7817-686a-4e91-8497-1af6d2e436dc

Create Debitor: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "holder.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "contact.uuid" : "012d7817-686a-4e91-8497-1af6d2e436dc" // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
  },
  "debitorNumberSuffix" : "01",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "a1ed4017-70a6-4b09-9cbf-433a80ca9d48", // BankAccount: Fischer Pflege GmbH (P-90002/1)
  "defaultPrefix" : "aad"
}
EOF
=> status: 201 CREATED 07d69bf8-e581-45eb-b46f-2616d41a08d7

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/07d69bf8-e581-45eb-b46f-2616d41a08d7" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "07d69bf8-e581-45eb-b46f-2616d41a08d7",
  "debitorRel" : {
    "uuid" : "ad1b6c14-8b97-4143-b632-6be3abcf3f09",
    "anchor" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "012d7817-686a-4e91-8497-1af6d2e436dc", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung1@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000201",
  "debitorNumberSuffix" : "01",
  "partner" : {
    "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "a1ed4017-70a6-4b09-9cbf-433a80ca9d48", // BankAccount: Fischer Pflege GmbH (P-90002/1)
    "holder" : "Fischer Pflege GmbH (P-90002/1)",
    "iban" : "DE44990100000597317337",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aad"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000201-aktuell

Properties

Given

name	value
debitorNumber	D-9000201
mandateReference	D-9000201-aktuell
bankAccountHolder	Fischer Pflege GmbH (P-90002/1/aktuell)
iban	DE41990100000935066832
bic	DEMSDEH0
agreement	2020-07-10
validFrom	2020-07-14

Debitor of D-9000201-aktuell

HTTP GET "/api/hs/office/debitors/D-9000201" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "07d69bf8-e581-45eb-b46f-2616d41a08d7",
  "debitorRel" : {
    "uuid" : "ad1b6c14-8b97-4143-b632-6be3abcf3f09",
    "anchor" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "012d7817-686a-4e91-8497-1af6d2e436dc", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
      "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung1@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000201",
  "debitorNumberSuffix" : "01",
  "partner" : {
    "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd",
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "a1ed4017-70a6-4b09-9cbf-433a80ca9d48", // BankAccount: Fischer Pflege GmbH (P-90002/1)
    "holder" : "Fischer Pflege GmbH (P-90002/1)",
    "iban" : "DE44990100000597317337",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aad"
}

BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fischer Pflege GmbH (P-90002/1/aktuell)",
  "iban" : "DE41990100000935066832",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 51eca5b6-98e5-4d80-850a-98069f29f799

Create SEPA-Mandat: D-9000201-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "07d69bf8-e581-45eb-b46f-2616d41a08d7", // Debitor of D-9000201-aktuell
  "bankAccount.uuid" : "51eca5b6-98e5-4d80-850a-98069f29f799", // BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)
  "reference" : "D-9000201-aktuell",
  "agreement" : "2020-07-10",
  "validFrom" : "2020-07-14"
}
EOF
=> status: 201 CREATED 4f36f7a4-f666-4042-926d-80cb586e6217

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/4f36f7a4-f666-4042-926d-80cb586e6217" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "4f36f7a4-f666-4042-926d-80cb586e6217",
  "debitor" : {
    "uuid" : "07d69bf8-e581-45eb-b46f-2616d41a08d7", // Debitor of D-9000201-aktuell
    "debitorRel" : {
      "uuid" : "ad1b6c14-8b97-4143-b632-6be3abcf3f09",
      "anchor" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "012d7817-686a-4e91-8497-1af6d2e436dc", // Contact: Fischer Pflege GmbH - Rechnungsstelle (D-9000201)
        "caption" : "Fischer Pflege GmbH - Rechnungsstelle (D-9000201)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung1@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000201",
    "debitorNumberSuffix" : "01",
    "partner" : {
      "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd",
      "partnerNumber" : "P-90002",
      "partnerRel" : {
        "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
        "anchor" : {
          "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Fischer Pflege GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
          "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
          "postalAddress" : {
            "zipcode" : "28195",
            "country" : "Germany",
            "city" : "Bremen",
            "street" : "Bachstraße 553"
          },
          "emailAddresses" : {
            "main" : "info@fischer-pflege-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 171 3920003"
          }
        }
      },
      "details" : {
        "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
        "registrationOffice" : "Registergericht Bremen",
        "registrationNumber" : "310659",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "a1ed4017-70a6-4b09-9cbf-433a80ca9d48", // BankAccount: Fischer Pflege GmbH (P-90002/1)
      "holder" : "Fischer Pflege GmbH (P-90002/1)",
      "iban" : "DE44990100000597317337",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aad"
  },
  "bankAccount" : {
    "uuid" : "51eca5b6-98e5-4d80-850a-98069f29f799", // BankAccount: Fischer Pflege GmbH (P-90002/1/aktuell)
    "holder" : "Fischer Pflege GmbH (P-90002/1/aktuell)",
    "iban" : "DE41990100000935066832",
    "bic" : "DEMSDEH0"
  },
  "reference" : "D-9000201-aktuell",
  "agreement" : "2020-07-10",
  "validFrom" : "2020-07-14",
  "validTo" : null
}

UseCase Create Membership => Membership: Fischer Pflege GmbH

Properties

Given

name	value
partnerNumber	P-90002
validFrom	2010-07-10
membershipFeeBillable	true

Partner: P-90002

HTTP GET "/api/hs/office/partners/P-90002" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd",
  "partnerNumber" : "P-90002",
  "partnerRel" : {
    "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
    "anchor" : {
      "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fischer Pflege GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
      "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
      "postalAddress" : {
        "zipcode" : "28195",
        "country" : "Germany",
        "city" : "Bremen",
        "street" : "Bachstraße 553"
      },
      "emailAddresses" : {
        "main" : "info@fischer-pflege-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 171 3920003"
      }
    }
  },
  "details" : {
    "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
    "registrationOffice" : "Registergericht Bremen",
    "registrationNumber" : "310659",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Fischer Pflege GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd", // Partner: P-90002
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2010-07-10",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED a134a6ed-4216-445c-8105-09deaff9399d

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/a134a6ed-4216-445c-8105-09deaff9399d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a134a6ed-4216-445c-8105-09deaff9399d",
  "partner" : {
    "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000200
reference	sign 2010-07-10
shareCount	35
comment	initial shares on joining
transactionDate	2010-07-10

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a134a6ed-4216-445c-8105-09deaff9399d",
  "partner" : {
    "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "a134a6ed-4216-445c-8105-09deaff9399d", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2010-07-10",
  "shareCount" : 35,
  "comment" : "initial shares on joining",
  "valueDate" : "2010-07-10"
}
EOF
=> status: 201 CREATED 5cda031f-d58d-4f83-bb84-8219c3a26250

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/5cda031f-d58d-4f83-bb84-8219c3a26250" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "5cda031f-d58d-4f83-bb84-8219c3a26250",
  "membership.uuid" : "a134a6ed-4216-445c-8105-09deaff9399d", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 35,
  "valueDate" : "2010-07-10",
  "reference" : "sign 2010-07-10",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000200
reference	sign 2010-07-10
assetValue	2240
comment	deposit for initial shares
transactionDate	2010-07-11

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000200" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "a134a6ed-4216-445c-8105-09deaff9399d", // membershipUuid
  "partner" : {
    "uuid" : "e916a0e2-81ad-4406-85cd-affca17666dd", // Partner: P-90002
    "partnerNumber" : "P-90002",
    "partnerRel" : {
      "uuid" : "09c4c985-5cf0-47f1-97c6-f12121261b76",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fischer Pflege GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "7de51c76-f671-4489-827a-32107a0c08ee", // Contact: Fischer Pflege GmbH - Hauptkontakt (P-90002)
        "caption" : "Fischer Pflege GmbH - Hauptkontakt (P-90002)",
        "postalAddress" : {
          "zipcode" : "28195",
          "country" : "Germany",
          "city" : "Bremen",
          "street" : "Bachstraße 553"
        },
        "emailAddresses" : {
          "main" : "info@fischer-pflege-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920003"
        }
      }
    },
    "details" : {
      "uuid" : "310854a2-51ab-4455-9ebc-12640d4c46af",
      "registrationOffice" : "Registergericht Bremen",
      "registrationNumber" : "310659",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000200",
  "memberNumberSuffix" : "00",
  "validFrom" : "2010-07-10",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "a134a6ed-4216-445c-8105-09deaff9399d", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2010-07-10",
  "assetValue" : 2240,
  "comment" : "deposit for initial shares",
  "valueDate" : "2010-07-11"
}
EOF
=> status: 201 CREATED 7f32af30-6cb6-4682-b376-4c4e0d49fd8d

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/7f32af30-6cb6-4682-b376-4c4e0d49fd8d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7f32af30-6cb6-4682-b376-4c4e0d49fd8d",
  "membership.uuid" : "a134a6ed-4216-445c-8105-09deaff9399d", // membershipUuid
  "membership.memberNumber" : "M-9000200",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2.24E+3,
  "valueDate" : "2010-07-11",
  "reference" : "sign 2010-07-10",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

Contact: Daniel Fischer - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Erlenkamp 678",
    "zipcode" : "70173",
    "city" : "Stuttgart",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 176 04069030"
  },
  "emailAddresses" : {
    "main" : "daniel-fischer@example.net"
  }
}
EOF
=> status: 201 CREATED eb5a5219-1dc6-42a7-bf05-814887afb4b0

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Daniel Fischer (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
mailingList	members-announce
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Daniel Fischer (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
  "holder.uuid" : "1f9ce160-a39c-4e6d-9bb4-93d1af543c3a", // Person: Daniel Fischer
  "contact.uuid" : "eb5a5219-1dc6-42a7-bf05-814887afb4b0" // Contact: Daniel Fischer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 225aea63-04e3-41eb-ba10-9dc5737124ba

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/225aea63-04e3-41eb-ba10-9dc5737124ba" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "225aea63-04e3-41eb-ba10-9dc5737124ba",
  "anchor" : {
    "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "1f9ce160-a39c-4e6d-9bb4-93d1af543c3a", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "eb5a5219-1dc6-42a7-bf05-814887afb4b0", // Contact: Daniel Fischer - private Mailinglisten-Adresse
    "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "70173",
      "country" : "Germany",
      "city" : "Stuttgart",
      "street" : "Erlenkamp 678"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 176 04069030"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Daniel Fischer (P-90002)

Properties

Given

name	value
partnerPersonName	Fischer Pflege GmbH
mailingList	customers-announce
holderGivenName	Daniel
holderFamilyName	Fischer
contactCaption	Daniel Fischer - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Daniel Fischer (P-90002)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
  "holder.uuid" : "1f9ce160-a39c-4e6d-9bb4-93d1af543c3a", // Person: Daniel Fischer
  "contact.uuid" : "eb5a5219-1dc6-42a7-bf05-814887afb4b0" // Contact: Daniel Fischer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 550b5004-42c0-4fb5-8629-b2efee824da0

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/550b5004-42c0-4fb5-8629-b2efee824da0" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "550b5004-42c0-4fb5-8629-b2efee824da0",
  "anchor" : {
    "uuid" : "162598de-bdac-4cdc-a090-eb14f3bc24db", // Person: Fischer Pflege GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fischer Pflege GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "1f9ce160-a39c-4e6d-9bb4-93d1af543c3a", // Person: Daniel Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Daniel",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "eb5a5219-1dc6-42a7-bf05-814887afb4b0", // Contact: Daniel Fischer - private Mailinglisten-Adresse
    "caption" : "Daniel Fischer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "70173",
      "country" : "Germany",
      "city" : "Stuttgart",
      "street" : "Erlenkamp 678"
    },
    "emailAddresses" : {
      "main" : "daniel-fischer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 176 04069030"
    }
  }
}

UseCase Create Partner => Partner: P-90003 - Fuchs GmbH

Properties

Given

name	value
partnerNumber	P-90003
personType	LEGAL_PERSON
contactCaption	Fuchs GmbH - Hauptkontakt (P-90003)
postalAddress	“name”: “Rechnungsstelle”, “street”: “Bachstraße 290”, “zipcode”: “80331”, “city”: “München”, “country”: “Germany”
officePhoneNumber	+49 89 99998009
emailAddress	info@fuchs-gmbh.example.org
tradeName	Fuchs GmbH
registrationOffice	Registergericht München
registrationNumber	322619

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Fuchs GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Fuchs GmbH"
}
EOF
=> status: 201 CREATED 3e755b37-31e9-49b5-848e-4c1b2887b2e7

Contact: Fuchs GmbH - Hauptkontakt (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
  "postalAddress" : {
    "name" : "Rechnungsstelle",
    "street" : "Bachstraße 290",
    "zipcode" : "80331",
    "city" : "München",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 89 99998009"
  },
  "emailAddresses" : {
    "main" : "info@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED db5d255c-4948-4fae-be97-e1eba04252fa

Create Partner: P-90003 - Fuchs GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90003",
  "partnerRel" : {
    "anchor.uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "holder.uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "contact.uuid" : "db5d255c-4948-4fae-be97-e1eba04252fa" // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
  },
  "details" : {
    "registrationOffice" : "Registergericht München",
    "registrationNumber" : "322619"
  }
}
EOF
=> status: 201 CREATED 993b0650-15c3-4b17-b75b-36bbd7baf1a7

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Fuchs+GmbH+-+Hauptkontakt+%28P-90003%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "43610c7a-3cca-4c71-b9e2-29e7f2457adc",
  "anchor" : {
    "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "db5d255c-4948-4fae-be97-e1eba04252fa", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
    "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
    "postalAddress" : {
      "zipcode" : "80331",
      "country" : "Germany",
      "city" : "München",
      "street" : "Bachstraße 290",
      "name" : "Rechnungsstelle"
    },
    "emailAddresses" : {
      "main" : "info@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 89 99998009"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Christian Fuchs - Vertretung (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
relationType	REPRESENTATIVE
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - Vertretung (P-90003)
postalAddress	“street”: “Heideweg 441”, “zipcode”: “10115”, “city”: “Berlin”, “country”: “Germany”
phoneNumber	+49 30 23125540
emailAddress	christian-fuchs@fuchs-gmbh.example.org

Person: Christian Fuchs

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fuchs",
  "givenName" : "Christian"
}
EOF
=> status: 201 CREATED a31f1b32-91cc-4a17-8e6c-872397eae63a

Contact: Christian Fuchs - Vertretung (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Fuchs - Vertretung (P-90003)",
  "postalAddress" : {
    "street" : "Heideweg 441",
    "zipcode" : "10115",
    "city" : "Berlin",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 30 23125540"
  },
  "emailAddresses" : {
    "main" : "christian-fuchs@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 10a84661-ca05-4a6a-b406-b8e55d4e5c61

Create REPRESENTATIVE: Christian Fuchs - Vertretung (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
  "holder.uuid" : "a31f1b32-91cc-4a17-8e6c-872397eae63a", // Person: Christian Fuchs
  "contact.uuid" : "10a84661-ca05-4a6a-b406-b8e55d4e5c61" // Contact: Christian Fuchs - Vertretung (P-90003)
}
EOF
=> status: 201 CREATED d07cb18c-5a89-4324-8efe-55dd19b3ac03

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/d07cb18c-5a89-4324-8efe-55dd19b3ac03" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d07cb18c-5a89-4324-8efe-55dd19b3ac03",
  "anchor" : {
    "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a31f1b32-91cc-4a17-8e6c-872397eae63a", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "10a84661-ca05-4a6a-b406-b8e55d4e5c61", // Contact: Christian Fuchs - Vertretung (P-90003)
    "caption" : "Christian Fuchs - Vertretung (P-90003)",
    "postalAddress" : {
      "zipcode" : "10115",
      "country" : "Germany",
      "city" : "Berlin",
      "street" : "Heideweg 441"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 30 23125540"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Gabriele Meyer - Technik (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
relationType	OPERATIONS
holderGivenName	Gabriele
holderFamilyName	Meyer
contactCaption	Gabriele Meyer - Technik (P-90003)
postalAddress	“street”: “Wiesengrund 118”, “zipcode”: “28195”, “city”: “Bremen”, “country”: “Germany”
phoneNumber	+49 171 3920029
emailAddress	gabriele-meyer@fuchs-gmbh.example.org

Person: Gabriele Meyer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Meyer",
  "givenName" : "Gabriele"
}
EOF
=> status: 201 CREATED 67349aec-3063-46f1-a16b-443446d86a23

Contact: Gabriele Meyer - Technik (P-90003)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Gabriele Meyer - Technik (P-90003)",
  "postalAddress" : {
    "street" : "Wiesengrund 118",
    "zipcode" : "28195",
    "city" : "Bremen",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 171 3920029"
  },
  "emailAddresses" : {
    "main" : "gabriele-meyer@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED d11a51e1-33d0-4317-ad32-5adee7297fcf

Create OPERATIONS: Gabriele Meyer - Technik (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
  "holder.uuid" : "67349aec-3063-46f1-a16b-443446d86a23", // Person: Gabriele Meyer
  "contact.uuid" : "d11a51e1-33d0-4317-ad32-5adee7297fcf" // Contact: Gabriele Meyer - Technik (P-90003)
}
EOF
=> status: 201 CREATED f5477c12-5ad8-4393-9ebc-d6322898d74f

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/f5477c12-5ad8-4393-9ebc-d6322898d74f" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "f5477c12-5ad8-4393-9ebc-d6322898d74f",
  "anchor" : {
    "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "67349aec-3063-46f1-a16b-443446d86a23", // Person: Gabriele Meyer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Gabriele",
    "familyName" : "Meyer"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "d11a51e1-33d0-4317-ad32-5adee7297fcf", // Contact: Gabriele Meyer - Technik (P-90003)
    "caption" : "Gabriele Meyer - Technik (P-90003)",
    "postalAddress" : {
      "zipcode" : "28195",
      "country" : "Germany",
      "city" : "Bremen",
      "street" : "Wiesengrund 118"
    },
    "emailAddresses" : {
      "main" : "gabriele-meyer@fuchs-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 171 3920029"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Fuchs GmbH - Rechnungsstelle (D-9000300)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aae
bankAccountHolder	Fuchs GmbH (P-90003/0)
iban	DE44990300000591816846
bic	DEMRDEF0
billingContactCaption	Fuchs GmbH - Rechnungsstelle (D-9000300)
billingContactEmailAddress	rechnung0@fuchs-gmbh.example.org

BankAccount: Fuchs GmbH (P-90003/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Fuchs GmbH (P-90003/0)",
  "iban" : "DE44990300000591816846",
  "bic" : "DEMRDEF0"
}
EOF
=> status: 201 CREATED ef942dd4-e83c-4f4b-b4ac-ad8f00399b42

Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Fuchs GmbH - Rechnungsstelle (D-9000300)",
  "emailAddresses" : {
    "main" : "rechnung0@fuchs-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 3a7c8c41-04a9-4b02-ad70-13e22bccf80b

Create Debitor: Fuchs GmbH - Rechnungsstelle (D-9000300)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "holder.uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "contact.uuid" : "3a7c8c41-04a9-4b02-ad70-13e22bccf80b" // Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "ef942dd4-e83c-4f4b-b4ac-ad8f00399b42", // BankAccount: Fuchs GmbH (P-90003/0)
  "defaultPrefix" : "aae"
}
EOF
=> status: 201 CREATED f3d75873-1b84-4bff-b5bc-dedb7e38ee47

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/f3d75873-1b84-4bff-b5bc-dedb7e38ee47" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "f3d75873-1b84-4bff-b5bc-dedb7e38ee47",
  "debitorRel" : {
    "uuid" : "5e94210f-1197-452b-815a-317e230d8de9",
    "anchor" : {
      "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "3a7c8c41-04a9-4b02-ad70-13e22bccf80b", // Contact: Fuchs GmbH - Rechnungsstelle (D-9000300)
      "caption" : "Fuchs GmbH - Rechnungsstelle (D-9000300)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@fuchs-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000300",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "993b0650-15c3-4b17-b75b-36bbd7baf1a7",
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "43610c7a-3cca-4c71-b9e2-29e7f2457adc",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "db5d255c-4948-4fae-be97-e1eba04252fa", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "438abe2d-7306-47fe-b514-685620c57c42",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "ef942dd4-e83c-4f4b-b4ac-ad8f00399b42", // BankAccount: Fuchs GmbH (P-90003/0)
    "holder" : "Fuchs GmbH (P-90003/0)",
    "iban" : "DE44990300000591816846",
    "bic" : "DEMRDEF0"
  },
  "defaultPrefix" : "aae"
}

UseCase Create Membership => Membership: Fuchs GmbH

Properties

Given

name	value
partnerNumber	P-90003
validFrom	2002-02-07
membershipFeeBillable	true

Partner: P-90003

HTTP GET "/api/hs/office/partners/P-90003" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "993b0650-15c3-4b17-b75b-36bbd7baf1a7",
  "partnerNumber" : "P-90003",
  "partnerRel" : {
    "uuid" : "43610c7a-3cca-4c71-b9e2-29e7f2457adc",
    "anchor" : {
      "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Fuchs GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "db5d255c-4948-4fae-be97-e1eba04252fa", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
      "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
      "postalAddress" : {
        "zipcode" : "80331",
        "country" : "Germany",
        "city" : "München",
        "street" : "Bachstraße 290",
        "name" : "Rechnungsstelle"
      },
      "emailAddresses" : {
        "main" : "info@fuchs-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 89 99998009"
      }
    }
  },
  "details" : {
    "uuid" : "438abe2d-7306-47fe-b514-685620c57c42",
    "registrationOffice" : "Registergericht München",
    "registrationNumber" : "322619",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Fuchs GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "993b0650-15c3-4b17-b75b-36bbd7baf1a7", // Partner: P-90003
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2002-02-07",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 88bf1902-31a1-4743-85b4-ce381557494d

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/88bf1902-31a1-4743-85b4-ce381557494d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "88bf1902-31a1-4743-85b4-ce381557494d",
  "partner" : {
    "uuid" : "993b0650-15c3-4b17-b75b-36bbd7baf1a7", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "43610c7a-3cca-4c71-b9e2-29e7f2457adc",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "db5d255c-4948-4fae-be97-e1eba04252fa", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "438abe2d-7306-47fe-b514-685620c57c42",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000300
reference	sign 2002-02-07
shareCount	38
comment	initial shares on joining
transactionDate	2002-02-07

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000300" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "88bf1902-31a1-4743-85b4-ce381557494d",
  "partner" : {
    "uuid" : "993b0650-15c3-4b17-b75b-36bbd7baf1a7", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "43610c7a-3cca-4c71-b9e2-29e7f2457adc",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "db5d255c-4948-4fae-be97-e1eba04252fa", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "438abe2d-7306-47fe-b514-685620c57c42",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "88bf1902-31a1-4743-85b4-ce381557494d", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2002-02-07",
  "shareCount" : 38,
  "comment" : "initial shares on joining",
  "valueDate" : "2002-02-07"
}
EOF
=> status: 201 CREATED c11b6a6d-15a3-47d4-9fe0-a54a67038176

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/c11b6a6d-15a3-47d4-9fe0-a54a67038176" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "c11b6a6d-15a3-47d4-9fe0-a54a67038176",
  "membership.uuid" : "88bf1902-31a1-4743-85b4-ce381557494d", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 38,
  "valueDate" : "2002-02-07",
  "reference" : "sign 2002-02-07",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000300
reference	sign 2002-02-07
assetValue	2432
comment	deposit for initial shares
transactionDate	2002-02-17

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000300" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "88bf1902-31a1-4743-85b4-ce381557494d", // membershipUuid
  "partner" : {
    "uuid" : "993b0650-15c3-4b17-b75b-36bbd7baf1a7", // Partner: P-90003
    "partnerNumber" : "P-90003",
    "partnerRel" : {
      "uuid" : "43610c7a-3cca-4c71-b9e2-29e7f2457adc",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Fuchs GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "db5d255c-4948-4fae-be97-e1eba04252fa", // Contact: Fuchs GmbH - Hauptkontakt (P-90003)
        "caption" : "Fuchs GmbH - Hauptkontakt (P-90003)",
        "postalAddress" : {
          "zipcode" : "80331",
          "country" : "Germany",
          "city" : "München",
          "street" : "Bachstraße 290",
          "name" : "Rechnungsstelle"
        },
        "emailAddresses" : {
          "main" : "info@fuchs-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 89 99998009"
        }
      }
    },
    "details" : {
      "uuid" : "438abe2d-7306-47fe-b514-685620c57c42",
      "registrationOffice" : "Registergericht München",
      "registrationNumber" : "322619",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000300",
  "memberNumberSuffix" : "00",
  "validFrom" : "2002-02-07",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "88bf1902-31a1-4743-85b4-ce381557494d", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2002-02-07",
  "assetValue" : 2432,
  "comment" : "deposit for initial shares",
  "valueDate" : "2002-02-17"
}
EOF
=> status: 201 CREATED 36dc7af9-249f-4942-9abb-3f09aa42224e

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/36dc7af9-249f-4942-9abb-3f09aa42224e" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "36dc7af9-249f-4942-9abb-3f09aa42224e",
  "membership.uuid" : "88bf1902-31a1-4743-85b4-ce381557494d", // membershipUuid
  "membership.memberNumber" : "M-9000300",
  "transactionType" : "DEPOSIT",
  "assetValue" : 2432,
  "valueDate" : "2002-02-17",
  "reference" : "sign 2002-02-07",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

Contact: Christian Fuchs - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Blumenstraße 234",
    "zipcode" : "30159",
    "city" : "Hannover",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 171 3920060"
  },
  "emailAddresses" : {
    "main" : "christian-fuchs@example.net"
  }
}
EOF
=> status: 201 CREATED 5a771898-35c3-45d1-af7d-dd7493eefce3

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	generalversammlung
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER generalversammlung: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
  "holder.uuid" : "a31f1b32-91cc-4a17-8e6c-872397eae63a", // Person: Christian Fuchs
  "contact.uuid" : "5a771898-35c3-45d1-af7d-dd7493eefce3" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 6db48f1f-f97f-4db2-a3ad-1f54c45b4ed8

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/6db48f1f-f97f-4db2-a3ad-1f54c45b4ed8" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "6db48f1f-f97f-4db2-a3ad-1f54c45b4ed8",
  "anchor" : {
    "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a31f1b32-91cc-4a17-8e6c-872397eae63a", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "5a771898-35c3-45d1-af7d-dd7493eefce3", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	members-announce
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
  "holder.uuid" : "a31f1b32-91cc-4a17-8e6c-872397eae63a", // Person: Christian Fuchs
  "contact.uuid" : "5a771898-35c3-45d1-af7d-dd7493eefce3" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 0a6f7e00-33d3-4f81-9e42-eb69fe68511f

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/0a6f7e00-33d3-4f81-9e42-eb69fe68511f" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "0a6f7e00-33d3-4f81-9e42-eb69fe68511f",
  "anchor" : {
    "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a31f1b32-91cc-4a17-8e6c-872397eae63a", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "5a771898-35c3-45d1-af7d-dd7493eefce3", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER customers-announce: Christian Fuchs (P-90003)

Properties

Given

name	value
partnerPersonName	Fuchs GmbH
mailingList	customers-announce
holderGivenName	Christian
holderFamilyName	Fuchs
contactCaption	Christian Fuchs - private Mailinglisten-Adresse

Create SUBSCRIBER customers-announce: Christian Fuchs (P-90003)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "anchor.uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
  "holder.uuid" : "a31f1b32-91cc-4a17-8e6c-872397eae63a", // Person: Christian Fuchs
  "contact.uuid" : "5a771898-35c3-45d1-af7d-dd7493eefce3" // Contact: Christian Fuchs - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 824bd64f-7529-40c6-98cf-16159d57a9c1

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/824bd64f-7529-40c6-98cf-16159d57a9c1" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "824bd64f-7529-40c6-98cf-16159d57a9c1",
  "anchor" : {
    "uuid" : "3e755b37-31e9-49b5-848e-4c1b2887b2e7", // Person: Fuchs GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Fuchs GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "a31f1b32-91cc-4a17-8e6c-872397eae63a", // Person: Christian Fuchs
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Christian",
    "familyName" : "Fuchs"
  },
  "type" : "SUBSCRIBER",
  "mark" : "customers-announce",
  "contact" : {
    "uuid" : "5a771898-35c3-45d1-af7d-dd7493eefce3", // Contact: Christian Fuchs - private Mailinglisten-Adresse
    "caption" : "Christian Fuchs - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "30159",
      "country" : "Germany",
      "city" : "Hannover",
      "street" : "Blumenstraße 234"
    },
    "emailAddresses" : {
      "main" : "christian-fuchs@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 171 3920060"
    }
  }
}

UseCase Create Partner => Partner: P-90004 - Schäfer Elektro GmbH

Properties

Given

name	value
partnerNumber	P-90004
personType	LEGAL_PERSON
contactCaption	Schäfer Elektro GmbH - Hauptkontakt (P-90004)
postalAddress	“name”: “Buchhaltung”, “street”: “Veilchenweg 528”, “zipcode”: “44135”, “city”: “Dortmund”, “country”: “Germany”
officePhoneNumber	+49 176 04069082
emailAddress	info@schaefer-elektro-gmbh.example.org
tradeName	Schäfer Elektro GmbH
registrationOffice	Registergericht Dortmund
registrationNumber	619312

Person: Hostsharing eG

HTTP GET "/api/hs/office/persons?name=Hostsharing+eG" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Hostsharing eG",
  "salutation" : null,
  "title" : null,
  "givenName" : null,
  "familyName" : null
} ]

Even in production data we expect this query to return just a single result.

Person: Schäfer Elektro GmbH

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "LEGAL_PERSON",
  "tradeName" : "Schäfer Elektro GmbH"
}
EOF
=> status: 201 CREATED 17cabc4c-1146-494a-a376-4d1e38416740

Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Veilchenweg 528",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069082"
  },
  "emailAddresses" : {
    "main" : "info@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 5953b2d6-2299-4069-b490-522d9ea0459e

Create Partner: P-90004 - Schäfer Elektro GmbH

HTTP POST "/api/hs/office/partners" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partnerNumber" : "P-90004",
  "partnerRel" : {
    "anchor.uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "holder.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "contact.uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e" // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
  },
  "details" : {
    "registrationOffice" : "Registergericht Dortmund",
    "registrationNumber" : "619312"
  }
}
EOF
=> status: 201 CREATED 5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2

Verify the New Partner Relation

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Sch%C3%A4fer+Elektro+GmbH+-+Hauptkontakt+%28P-90004%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
  "anchor" : {
    "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
    "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Veilchenweg 528",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "info@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069082"
    }
  }
} ]

UseCase Add Demo Relation => REPRESENTATIVE: Jana Schäfer - Vertretung (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	REPRESENTATIVE
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - Vertretung (P-90004)
postalAddress	“street”: “Schulstraße 334”, “zipcode”: “34117”, “city”: “Kassel”, “country”: “Germany”
phoneNumber	+49 176 04069020
emailAddress	jana-schaefer@schaefer-elektro-gmbh.example.org

Person: Jana Schäfer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schäfer",
  "givenName" : "Jana"
}
EOF
=> status: 201 CREATED f69c9b4c-b23f-4368-a8dd-e6b6eb653c8d

Contact: Jana Schäfer - Vertretung (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Jana Schäfer - Vertretung (P-90004)",
  "postalAddress" : {
    "street" : "Schulstraße 334",
    "zipcode" : "34117",
    "city" : "Kassel",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069020"
  },
  "emailAddresses" : {
    "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 89234dbc-9758-468d-8d70-a1a381586640

Create REPRESENTATIVE: Jana Schäfer - Vertretung (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "REPRESENTATIVE",
  "anchor.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "f69c9b4c-b23f-4368-a8dd-e6b6eb653c8d", // Person: Jana Schäfer
  "contact.uuid" : "89234dbc-9758-468d-8d70-a1a381586640" // Contact: Jana Schäfer - Vertretung (P-90004)
}
EOF
=> status: 201 CREATED d879754b-b429-4268-b723-170fd7770909

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/d879754b-b429-4268-b723-170fd7770909" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "d879754b-b429-4268-b723-170fd7770909",
  "anchor" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "f69c9b4c-b23f-4368-a8dd-e6b6eb653c8d", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "REPRESENTATIVE",
  "mark" : null,
  "contact" : {
    "uuid" : "89234dbc-9758-468d-8d70-a1a381586640", // Contact: Jana Schäfer - Vertretung (P-90004)
    "caption" : "Jana Schäfer - Vertretung (P-90004)",
    "postalAddress" : {
      "zipcode" : "34117",
      "country" : "Germany",
      "city" : "Kassel",
      "street" : "Schulstraße 334"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069020"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Claudia Schmitt - Technik (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	OPERATIONS
holderGivenName	Claudia
holderFamilyName	Schmitt
contactCaption	Claudia Schmitt - Technik (P-90004)
postalAddress	“street”: “Heideweg 201”, “zipcode”: “60311”, “city”: “Frankfurt am Main”, “country”: “Germany”
phoneNumber	+49 69 90009159
emailAddress	claudia-schmitt@schaefer-elektro-gmbh.example.org

Person: Claudia Schmitt

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Schmitt",
  "givenName" : "Claudia"
}
EOF
=> status: 201 CREATED ed4cd142-82a7-4e1a-8fa1-baacb8aac574

Contact: Claudia Schmitt - Technik (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Claudia Schmitt - Technik (P-90004)",
  "postalAddress" : {
    "street" : "Heideweg 201",
    "zipcode" : "60311",
    "city" : "Frankfurt am Main",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 69 90009159"
  },
  "emailAddresses" : {
    "main" : "claudia-schmitt@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 4d9b8f94-e943-4bcb-8b15-e1f8cc021d56

Create OPERATIONS: Claudia Schmitt - Technik (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "ed4cd142-82a7-4e1a-8fa1-baacb8aac574", // Person: Claudia Schmitt
  "contact.uuid" : "4d9b8f94-e943-4bcb-8b15-e1f8cc021d56" // Contact: Claudia Schmitt - Technik (P-90004)
}
EOF
=> status: 201 CREATED 236d30b2-6e3c-4ad1-9933-5a9bb8873cb9

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/236d30b2-6e3c-4ad1-9933-5a9bb8873cb9" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "236d30b2-6e3c-4ad1-9933-5a9bb8873cb9",
  "anchor" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "ed4cd142-82a7-4e1a-8fa1-baacb8aac574", // Person: Claudia Schmitt
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Claudia",
    "familyName" : "Schmitt"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "4d9b8f94-e943-4bcb-8b15-e1f8cc021d56", // Contact: Claudia Schmitt - Technik (P-90004)
    "caption" : "Claudia Schmitt - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "60311",
      "country" : "Germany",
      "city" : "Frankfurt am Main",
      "street" : "Heideweg 201"
    },
    "emailAddresses" : {
      "main" : "claudia-schmitt@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 69 90009159"
    }
  }
}

UseCase Create Demo Debitor => Debitor: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
debitorNumberSuffix	00
billable	true
vatBusiness	true
defaultPrefix	aaf
bankAccountHolder	Schäfer Elektro GmbH (P-90004/0)
iban	DE18990100000374198599
bic	DEMSDEH0
billingContactCaption	Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
billingContactEmailAddress	rechnung0@schaefer-elektro-gmbh.example.org

BankAccount: Schäfer Elektro GmbH (P-90004/0)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Schäfer Elektro GmbH (P-90004/0)",
  "iban" : "DE18990100000374198599",
  "bic" : "DEMSDEH0"
}
EOF
=> status: 201 CREATED 3c16be99-67d9-408d-8692-db40cdceb24f

Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
  "emailAddresses" : {
    "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED bddb9fc8-8c24-47ab-9d19-9138a6e3e430

Create Debitor: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)

HTTP POST "/api/hs/office/debitors" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitorRel" : {
    "anchor.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "holder.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "contact.uuid" : "bddb9fc8-8c24-47ab-9d19-9138a6e3e430" // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
  },
  "debitorNumberSuffix" : "00",
  "billable" : true,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount.uuid" : "3c16be99-67d9-408d-8692-db40cdceb24f", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
  "defaultPrefix" : "aaf"
}
EOF
=> status: 201 CREATED 7ab0eb98-6521-4669-8ff4-46bfc5a7b82d

Verify the Debitor Got Created

HTTP GET "/api/hs/office/debitors/7ab0eb98-6521-4669-8ff4-46bfc5a7b82d" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7ab0eb98-6521-4669-8ff4-46bfc5a7b82d",
  "debitorRel" : {
    "uuid" : "f2383a57-2666-46ce-a22b-fa14e7dc7fc3",
    "anchor" : {
      "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "bddb9fc8-8c24-47ab-9d19-9138a6e3e430", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
      "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000400",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2",
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "b39e5cce-335e-42a5-9f39-ba4dc26a7caf",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "3c16be99-67d9-408d-8692-db40cdceb24f", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
    "holder" : "Schäfer Elektro GmbH (P-90004/0)",
    "iban" : "DE18990100000374198599",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aaf"
}

UseCase Create Demo Sepa Mandate => SEPA-Mandat: D-9000400-aktuell

Properties

Given

name	value
debitorNumber	D-9000400
mandateReference	D-9000400-aktuell
bankAccountHolder	Schäfer Elektro GmbH (P-90004/0/aktuell)
iban	DE13990400000527372297
bic	DEMDDEB0
agreement	2020-07-13
validFrom	2020-07-27

Debitor of D-9000400-aktuell

HTTP GET "/api/hs/office/debitors/D-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "7ab0eb98-6521-4669-8ff4-46bfc5a7b82d",
  "debitorRel" : {
    "uuid" : "f2383a57-2666-46ce-a22b-fa14e7dc7fc3",
    "anchor" : {
      "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "DEBITOR",
    "mark" : null,
    "contact" : {
      "uuid" : "bddb9fc8-8c24-47ab-9d19-9138a6e3e430", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
      "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
      "postalAddress" : { },
      "emailAddresses" : {
        "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : { }
    }
  },
  "debitorNumber" : "D-9000400",
  "debitorNumberSuffix" : "00",
  "partner" : {
    "uuid" : "5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2",
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "b39e5cce-335e-42a5-9f39-ba4dc26a7caf",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "billable" : true,
  "vatId" : null,
  "vatCountryCode" : null,
  "vatBusiness" : true,
  "vatReverseCharge" : false,
  "refundBankAccount" : {
    "uuid" : "3c16be99-67d9-408d-8692-db40cdceb24f", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
    "holder" : "Schäfer Elektro GmbH (P-90004/0)",
    "iban" : "DE18990100000374198599",
    "bic" : "DEMSDEH0"
  },
  "defaultPrefix" : "aaf"
}

BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)

HTTP POST "/api/hs/office/bankaccounts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "holder" : "Schäfer Elektro GmbH (P-90004/0/aktuell)",
  "iban" : "DE13990400000527372297",
  "bic" : "DEMDDEB0"
}
EOF
=> status: 201 CREATED 26865755-4faa-4685-91a0-9fdc42543f5c

Create SEPA-Mandat: D-9000400-aktuell

HTTP POST "/api/hs/office/sepamandates" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "debitor.uuid" : "7ab0eb98-6521-4669-8ff4-46bfc5a7b82d", // Debitor of D-9000400-aktuell
  "bankAccount.uuid" : "26865755-4faa-4685-91a0-9fdc42543f5c", // BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)
  "reference" : "D-9000400-aktuell",
  "agreement" : "2020-07-13",
  "validFrom" : "2020-07-27"
}
EOF
=> status: 201 CREATED 6c152cb8-5832-4297-a321-6b5e02a62d0b

Verify the SEPA-Mandate Got Created

HTTP GET "/api/hs/office/sepamandates/6c152cb8-5832-4297-a321-6b5e02a62d0b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "6c152cb8-5832-4297-a321-6b5e02a62d0b",
  "debitor" : {
    "uuid" : "7ab0eb98-6521-4669-8ff4-46bfc5a7b82d", // Debitor of D-9000400-aktuell
    "debitorRel" : {
      "uuid" : "f2383a57-2666-46ce-a22b-fa14e7dc7fc3",
      "anchor" : {
        "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "DEBITOR",
      "mark" : null,
      "contact" : {
        "uuid" : "bddb9fc8-8c24-47ab-9d19-9138a6e3e430", // Contact: Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)
        "caption" : "Schäfer Elektro GmbH - Rechnungsstelle (D-9000400)",
        "postalAddress" : { },
        "emailAddresses" : {
          "main" : "rechnung0@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : { }
      }
    },
    "debitorNumber" : "D-9000400",
    "debitorNumberSuffix" : "00",
    "partner" : {
      "uuid" : "5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2",
      "partnerNumber" : "P-90004",
      "partnerRel" : {
        "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
        "anchor" : {
          "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Hostsharing eG",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "holder" : {
          "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
          "personType" : "LEGAL_PERSON",
          "tradeName" : "Schäfer Elektro GmbH",
          "salutation" : null,
          "title" : null,
          "givenName" : null,
          "familyName" : null
        },
        "type" : "PARTNER",
        "mark" : null,
        "contact" : {
          "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
          "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
          "postalAddress" : {
            "zipcode" : "44135",
            "country" : "Germany",
            "city" : "Dortmund",
            "street" : "Veilchenweg 528",
            "name" : "Buchhaltung"
          },
          "emailAddresses" : {
            "main" : "info@schaefer-elektro-gmbh.example.org"
          },
          "phoneNumbers" : {
            "office" : "+49 176 04069082"
          }
        }
      },
      "details" : {
        "uuid" : "b39e5cce-335e-42a5-9f39-ba4dc26a7caf",
        "registrationOffice" : "Registergericht Dortmund",
        "registrationNumber" : "619312",
        "birthName" : null,
        "birthPlace" : null,
        "birthday" : null,
        "dateOfDeath" : null
      }
    },
    "billable" : true,
    "vatId" : null,
    "vatCountryCode" : null,
    "vatBusiness" : true,
    "vatReverseCharge" : false,
    "refundBankAccount" : {
      "uuid" : "3c16be99-67d9-408d-8692-db40cdceb24f", // BankAccount: Schäfer Elektro GmbH (P-90004/0)
      "holder" : "Schäfer Elektro GmbH (P-90004/0)",
      "iban" : "DE18990100000374198599",
      "bic" : "DEMSDEH0"
    },
    "defaultPrefix" : "aaf"
  },
  "bankAccount" : {
    "uuid" : "26865755-4faa-4685-91a0-9fdc42543f5c", // BankAccount: Schäfer Elektro GmbH (P-90004/0/aktuell)
    "holder" : "Schäfer Elektro GmbH (P-90004/0/aktuell)",
    "iban" : "DE13990400000527372297",
    "bic" : "DEMDDEB0"
  },
  "reference" : "D-9000400-aktuell",
  "agreement" : "2020-07-13",
  "validFrom" : "2020-07-27",
  "validTo" : null
}

UseCase Create Membership => Membership: Schäfer Elektro GmbH

Properties

Given

name	value
partnerNumber	P-90004
validFrom	2005-01-22
membershipFeeBillable	true

Partner: P-90004

HTTP GET "/api/hs/office/partners/P-90004" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2",
  "partnerNumber" : "P-90004",
  "partnerRel" : {
    "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
    "anchor" : {
      "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Hostsharing eG",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "holder" : {
      "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
      "personType" : "LEGAL_PERSON",
      "tradeName" : "Schäfer Elektro GmbH",
      "salutation" : null,
      "title" : null,
      "givenName" : null,
      "familyName" : null
    },
    "type" : "PARTNER",
    "mark" : null,
    "contact" : {
      "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
      "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
      "postalAddress" : {
        "zipcode" : "44135",
        "country" : "Germany",
        "city" : "Dortmund",
        "street" : "Veilchenweg 528",
        "name" : "Buchhaltung"
      },
      "emailAddresses" : {
        "main" : "info@schaefer-elektro-gmbh.example.org"
      },
      "phoneNumbers" : {
        "office" : "+49 176 04069082"
      }
    }
  },
  "details" : {
    "uuid" : "b39e5cce-335e-42a5-9f39-ba4dc26a7caf",
    "registrationOffice" : "Registergericht Dortmund",
    "registrationNumber" : "619312",
    "birthName" : null,
    "birthPlace" : null,
    "birthday" : null,
    "dateOfDeath" : null
  }
}

The partner-number identifies the partner; a lookup by name could not, because a natural person carries its name in two columns and any name can be the prefix of a longer one.

Create Membership: Schäfer Elektro GmbH

HTTP POST "/api/hs/office/memberships" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "partner.uuid" : "5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2", // Partner: P-90004
  "memberNumberSuffix" : "00",
  "status" : "ACTIVE",
  "validFrom" : "2005-01-22",
  "membershipFeeBillable" : true
}
EOF
=> status: 201 CREATED 99fa5684-d031-4fb9-a3ae-e2636e8d7a6b

Verify That the Membership Got Created

HTTP GET "/api/hs/office/memberships/99fa5684-d031-4fb9-a3ae-e2636e8d7a6b" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "99fa5684-d031-4fb9-a3ae-e2636e8d7a6b",
  "partner" : {
    "uuid" : "5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "b39e5cce-335e-42a5-9f39-ba4dc26a7caf",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Properties

Given

name	value
transactionType	SUBSCRIPTION
memberNumber	M-9000400
reference	sign 2005-01-22
shareCount	24
comment	initial shares on joining
transactionDate	2005-01-22

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "99fa5684-d031-4fb9-a3ae-e2636e8d7a6b",
  "partner" : {
    "uuid" : "5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "b39e5cce-335e-42a5-9f39-ba4dc26a7caf",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Shares-SUBSCRIPTION Transaction

HTTP POST "/api/hs/office/coopsharestransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "99fa5684-d031-4fb9-a3ae-e2636e8d7a6b", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "reference" : "sign 2005-01-22",
  "shareCount" : 24,
  "comment" : "initial shares on joining",
  "valueDate" : "2005-01-22"
}
EOF
=> status: 201 CREATED 970bb297-6918-4f81-a524-ce66e66954c2

Verify Coop-Shares SUBSCRIPTION-Transaction

HTTP GET "/api/hs/office/coopsharestransactions/970bb297-6918-4f81-a524-ce66e66954c2" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "970bb297-6918-4f81-a524-ce66e66954c2",
  "membership.uuid" : "99fa5684-d031-4fb9-a3ae-e2636e8d7a6b", // membershipUuid
  "transactionType" : "SUBSCRIPTION",
  "shareCount" : 24,
  "valueDate" : "2005-01-22",
  "reference" : "sign 2005-01-22",
  "comment" : "initial shares on joining",
  "revertedShareTx" : null,
  "reversalShareTx" : null
}

Properties

Given

name	value
transactionType	DEPOSIT
memberNumber	M-9000400
reference	sign 2005-01-22
assetValue	1536
comment	deposit for initial shares
transactionDate	2005-02-06

Find membershipUuid

HTTP GET "/api/hs/office/memberships/M-9000400" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "99fa5684-d031-4fb9-a3ae-e2636e8d7a6b", // membershipUuid
  "partner" : {
    "uuid" : "5657eebd-633e-4c93-b7ff-ab7e6ea0aaf2", // Partner: P-90004
    "partnerNumber" : "P-90004",
    "partnerRel" : {
      "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Schäfer Elektro GmbH",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
        "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
        "postalAddress" : {
          "zipcode" : "44135",
          "country" : "Germany",
          "city" : "Dortmund",
          "street" : "Veilchenweg 528",
          "name" : "Buchhaltung"
        },
        "emailAddresses" : {
          "main" : "info@schaefer-elektro-gmbh.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 176 04069082"
        }
      }
    },
    "details" : {
      "uuid" : "b39e5cce-335e-42a5-9f39-ba4dc26a7caf",
      "registrationOffice" : "Registergericht Dortmund",
      "registrationNumber" : "619312",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000400",
  "memberNumberSuffix" : "00",
  "validFrom" : "2005-01-22",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
}

Create the Coop-Assets-DEPOSIT Transaction

HTTP POST "/api/hs/office/coopassetstransactions" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "membership.uuid" : "99fa5684-d031-4fb9-a3ae-e2636e8d7a6b", // membershipUuid
  "transactionType" : "DEPOSIT",
  "reference" : "sign 2005-01-22",
  "assetValue" : 1536,
  "comment" : "deposit for initial shares",
  "valueDate" : "2005-02-06"
}
EOF
=> status: 201 CREATED f5414583-6b00-46c4-956d-8a79b482dc57

Verify Coop-Assets DEPOSIT-Transaction

HTTP GET "/api/hs/office/coopassetstransactions/f5414583-6b00-46c4-956d-8a79b482dc57" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "f5414583-6b00-46c4-956d-8a79b482dc57",
  "membership.uuid" : "99fa5684-d031-4fb9-a3ae-e2636e8d7a6b", // membershipUuid
  "membership.memberNumber" : "M-9000400",
  "transactionType" : "DEPOSIT",
  "assetValue" : 1536,
  "valueDate" : "2005-02-06",
  "reference" : "sign 2005-01-22",
  "comment" : "deposit for initial shares",
  "adoptionAssetTx" : null,
  "transferAssetTx" : null,
  "revertedAssetTx" : null,
  "reversalAssetTx" : null
}

UseCase Add Demo Subscription => SUBSCRIBER generalversammlung: Jana Schäfer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	generalversammlung
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - Vertretung (P-90004)

Create SUBSCRIBER generalversammlung: Jana Schäfer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "anchor.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "f69c9b4c-b23f-4368-a8dd-e6b6eb653c8d", // Person: Jana Schäfer
  "contact.uuid" : "89234dbc-9758-468d-8d70-a1a381586640" // Contact: Jana Schäfer - Vertretung (P-90004)
}
EOF
=> status: 201 CREATED b32f88d6-f273-404e-81cf-8a9165deda8c

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/b32f88d6-f273-404e-81cf-8a9165deda8c" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "b32f88d6-f273-404e-81cf-8a9165deda8c",
  "anchor" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "f69c9b4c-b23f-4368-a8dd-e6b6eb653c8d", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "generalversammlung",
  "contact" : {
    "uuid" : "89234dbc-9758-468d-8d70-a1a381586640", // Contact: Jana Schäfer - Vertretung (P-90004)
    "caption" : "Jana Schäfer - Vertretung (P-90004)",
    "postalAddress" : {
      "zipcode" : "34117",
      "country" : "Germany",
      "city" : "Kassel",
      "street" : "Schulstraße 334"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069020"
    }
  }
}

Contact: Jana Schäfer - private Mailinglisten-Adresse

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Jana Schäfer - private Mailinglisten-Adresse",
  "postalAddress" : {
    "street" : "Mühlenkamp 757",
    "zipcode" : "44135",
    "city" : "Dortmund",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "main" : "+49 172 9973186"
  },
  "emailAddresses" : {
    "main" : "jana-schaefer@example.net"
  }
}
EOF
=> status: 201 CREATED 3155f537-212d-4019-9abb-3e928a9d236d

UseCase Add Demo Subscription => SUBSCRIBER members-announce: Jana Schäfer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	members-announce
holderGivenName	Jana
holderFamilyName	Schäfer
contactCaption	Jana Schäfer - private Mailinglisten-Adresse

Create SUBSCRIBER members-announce: Jana Schäfer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "anchor.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "f69c9b4c-b23f-4368-a8dd-e6b6eb653c8d", // Person: Jana Schäfer
  "contact.uuid" : "3155f537-212d-4019-9abb-3e928a9d236d" // Contact: Jana Schäfer - private Mailinglisten-Adresse
}
EOF
=> status: 201 CREATED 55b9933b-ccbf-4db7-8112-fac568b0c0df

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/55b9933b-ccbf-4db7-8112-fac568b0c0df" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "55b9933b-ccbf-4db7-8112-fac568b0c0df",
  "anchor" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "f69c9b4c-b23f-4368-a8dd-e6b6eb653c8d", // Person: Jana Schäfer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Jana",
    "familyName" : "Schäfer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "members-announce",
  "contact" : {
    "uuid" : "3155f537-212d-4019-9abb-3e928a9d236d", // Contact: Jana Schäfer - private Mailinglisten-Adresse
    "caption" : "Jana Schäfer - private Mailinglisten-Adresse",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Mühlenkamp 757"
    },
    "emailAddresses" : {
      "main" : "jana-schaefer@example.net"
    },
    "phoneNumbers" : {
      "main" : "+49 172 9973186"
    }
  }
}

UseCase Add Demo Relation => OPERATIONS: Michael Fischer - Technik (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
relationType	OPERATIONS
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)
postalAddress	“name”: “Buchhaltung”, “street”: “Schlehenweg 867”, “zipcode”: “33602”, “city”: “Bielefeld”, “country”: “Germany”
phoneNumber	+49 176 04069045
emailAddress	michael-fischer@schaefer-elektro-gmbh.example.org

Person: Michael Fischer

HTTP POST "/api/hs/office/persons" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "personType" : "NATURAL_PERSON",
  "familyName" : "Fischer",
  "givenName" : "Michael"
}
EOF
=> status: 201 CREATED 18c40d4a-ec59-4d07-8c93-8d8ac709a70d

Contact: Michael Fischer - Technik (P-90004)

HTTP POST "/api/hs/office/contacts" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "caption" : "Michael Fischer - Technik (P-90004)",
  "postalAddress" : {
    "name" : "Buchhaltung",
    "street" : "Schlehenweg 867",
    "zipcode" : "33602",
    "city" : "Bielefeld",
    "country" : "Germany"
  },
  "phoneNumbers" : {
    "office" : "+49 176 04069045"
  },
  "emailAddresses" : {
    "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
  }
}
EOF
=> status: 201 CREATED 86c40eff-89f5-414e-bcfe-31b5bd4dbb0b

Create OPERATIONS: Michael Fischer - Technik (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "OPERATIONS",
  "anchor.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "18c40d4a-ec59-4d07-8c93-8d8ac709a70d", // Person: Michael Fischer
  "contact.uuid" : "86c40eff-89f5-414e-bcfe-31b5bd4dbb0b" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED 74887173-3b09-4fe6-8758-2b1b0bfa19b6

Verify the Relation Got Created

HTTP GET "/api/hs/office/relations/74887173-3b09-4fe6-8758-2b1b0bfa19b6" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "74887173-3b09-4fe6-8758-2b1b0bfa19b6",
  "anchor" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "18c40d4a-ec59-4d07-8c93-8d8ac709a70d", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "OPERATIONS",
  "mark" : null,
  "contact" : {
    "uuid" : "86c40eff-89f5-414e-bcfe-31b5bd4dbb0b", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-announce: Michael Fischer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	operations-announce
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)

Create SUBSCRIBER operations-announce: Michael Fischer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "anchor.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "18c40d4a-ec59-4d07-8c93-8d8ac709a70d", // Person: Michael Fischer
  "contact.uuid" : "86c40eff-89f5-414e-bcfe-31b5bd4dbb0b" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED df872fb7-a670-41d1-8573-84d4782698d2

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/df872fb7-a670-41d1-8573-84d4782698d2" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "df872fb7-a670-41d1-8573-84d4782698d2",
  "anchor" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "18c40d4a-ec59-4d07-8c93-8d8ac709a70d", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-announce",
  "contact" : {
    "uuid" : "86c40eff-89f5-414e-bcfe-31b5bd4dbb0b", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

UseCase Add Demo Subscription => SUBSCRIBER operations-discussion: Michael Fischer (P-90004)

Properties

Given

name	value
partnerPersonName	Schäfer Elektro GmbH
mailingList	operations-discussion
holderGivenName	Michael
holderFamilyName	Fischer
contactCaption	Michael Fischer - Technik (P-90004)

Create SUBSCRIBER operations-discussion: Michael Fischer (P-90004)

HTTP POST "/api/hs/office/relations" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY" \
  <<EOF
{
  "type" : "SUBSCRIBER",
  "mark" : "operations-discussion",
  "anchor.uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
  "holder.uuid" : "18c40d4a-ec59-4d07-8c93-8d8ac709a70d", // Person: Michael Fischer
  "contact.uuid" : "86c40eff-89f5-414e-bcfe-31b5bd4dbb0b" // Contact: Michael Fischer - Technik (P-90004)
}
EOF
=> status: 201 CREATED 2540f3fd-ec29-4f30-a0e7-556dc86e94a2

Verify the Subscription Got Created

HTTP GET "/api/hs/office/relations/2540f3fd-ec29-4f30-a0e7-556dc86e94a2" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
{
  "uuid" : "2540f3fd-ec29-4f30-a0e7-556dc86e94a2",
  "anchor" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "18c40d4a-ec59-4d07-8c93-8d8ac709a70d", // Person: Michael Fischer
    "personType" : "NATURAL_PERSON",
    "tradeName" : null,
    "salutation" : null,
    "title" : null,
    "givenName" : "Michael",
    "familyName" : "Fischer"
  },
  "type" : "SUBSCRIBER",
  "mark" : "operations-discussion",
  "contact" : {
    "uuid" : "86c40eff-89f5-414e-bcfe-31b5bd4dbb0b", // Contact: Michael Fischer - Technik (P-90004)
    "caption" : "Michael Fischer - Technik (P-90004)",
    "postalAddress" : {
      "zipcode" : "33602",
      "country" : "Germany",
      "city" : "Bielefeld",
      "street" : "Schlehenweg 867",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "michael-fischer@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069045"
    }
  }
}

Query the most recently generated demo partner

HTTP GET "/api/hs/office/relations?relationType=PARTNER&contactData=Sch%C3%A4fer+Elektro+GmbH+-+Hauptkontakt+%28P-90004%29" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "05cca0f7-4262-4c4a-8ae7-ef2110c8733c",
  "anchor" : {
    "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Hostsharing eG",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "holder" : {
    "uuid" : "17cabc4c-1146-494a-a376-4d1e38416740", // Person: Schäfer Elektro GmbH
    "personType" : "LEGAL_PERSON",
    "tradeName" : "Schäfer Elektro GmbH",
    "salutation" : null,
    "title" : null,
    "givenName" : null,
    "familyName" : null
  },
  "type" : "PARTNER",
  "mark" : null,
  "contact" : {
    "uuid" : "5953b2d6-2299-4069-b490-522d9ea0459e", // Contact: Schäfer Elektro GmbH - Hauptkontakt (P-90004)
    "caption" : "Schäfer Elektro GmbH - Hauptkontakt (P-90004)",
    "postalAddress" : {
      "zipcode" : "44135",
      "country" : "Germany",
      "city" : "Dortmund",
      "street" : "Veilchenweg 528",
      "name" : "Buchhaltung"
    },
    "emailAddresses" : {
      "main" : "info@schaefer-elektro-gmbh.example.org"
    },
    "phoneNumbers" : {
      "office" : "+49 176 04069082"
    }
  }
} ]

Verify the Showcase Cooperative Has Exactly One Membership

HTTP GET "/api/hs/office/memberships?partnerNumber=P-90000" \
  -H "Hostsharing-Api-Key: $HSADMINNG_API_KEY"
=> status: 200 OK 
[ {
  "uuid" : "1d02b16b-6fd4-4688-a529-8e2db1b29f04",
  "partner" : {
    "uuid" : "266f8564-c35b-4de7-8f74-6a96e5ff1216", // Partner: P-90000
    "partnerNumber" : "P-90000",
    "partnerRel" : {
      "uuid" : "75daf90a-b984-4772-b7ca-992f838e85c3",
      "anchor" : {
        "uuid" : "f1b6be2b-7ec8-4d8a-a690-90a846fd07d5", // Person: Hostsharing eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Hostsharing eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "holder" : {
        "uuid" : "412aca70-cbe0-4a02-82b2-5343b612fced", // Person: Tannenhof Bürotechnik eG
        "personType" : "LEGAL_PERSON",
        "tradeName" : "Tannenhof Bürotechnik eG",
        "salutation" : null,
        "title" : null,
        "givenName" : null,
        "familyName" : null
      },
      "type" : "PARTNER",
      "mark" : null,
      "contact" : {
        "uuid" : "4f60be17-812c-4f2d-b037-f7c15be947b9", // Contact: Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)
        "caption" : "Tannenhof Bürotechnik eG - Hauptkontakt (P-90000)",
        "postalAddress" : {
          "zipcode" : "86150",
          "country" : "Germany",
          "city" : "Augsburg",
          "street" : "Am Anger 167"
        },
        "emailAddresses" : {
          "main" : "info@tannenhof-buerotechnik-eg.example.org"
        },
        "phoneNumbers" : {
          "office" : "+49 171 3920080"
        }
      }
    },
    "details" : {
      "uuid" : "ff161315-98cd-4830-bdd8-693903263880",
      "registrationOffice" : "Registergericht Augsburg",
      "registrationNumber" : "555465",
      "birthName" : null,
      "birthPlace" : null,
      "birthday" : null,
      "dateOfDeath" : null
    }
  },
  "mainDebitor" : null,
  "memberNumber" : "M-9000000",
  "memberNumberSuffix" : "00",
  "validFrom" : "2011-05-13",
  "validTo" : null,
  "status" : "ACTIVE",
  "membershipFeeBillable" : true
} ]

generated on 2026-08-10 04:34:34 for branch HEAD